编写api常用工具swagger和redoc

已于 2022-06-20 17:55:56 修改
阅读量1.3k 收藏
点赞数
分类专栏： 思考 文章标签： github
于 2022-06-19 18:53:01 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/xxiangaa/article/details/125360988
版权
本文探讨了Swagger在GitHub部署的挑战，介绍了使用Swagger-github-pages和redoc一键部署的便利性。重点讲述了如何通过终端命令行操作和使用编辑器搭建，并对比了两者界面。适合开发者了解文档工具选择。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

  1. Swagger有点不好用。当然可以在github上部署，但是html文件里面找不到url
    使用连接：https://github.com/peter-evans/swagger-github-pages
    swagger-github
    git clone https://github.com/swagger-api/swagger-ui.git（还有editer）
    然后同级文件夹输入http-server -p 8080 swagger-editor
    其中使用了一些终端命令行
    在某文件夹创建py文件
    vim main.py
    终止代码Esc
    :wq
    一些使用教程：
    https://www.jianshu.com/p/d6626e6bd72c

  2. 最后使用redoc部署，感觉界面比swagger要略丑一点。但是比较方便
    一键部署：npx redoc-cli bundle openapi.yaml
    教程链接：https://dmlls.medium.com/redoc-docs-on-gh-pages-97a8926e9e0f

另外附检索技巧：学会用英文思维、语句在谷歌检索信息
在这里插入图片描述
参考网页：https://docs.stats.etdchain.net/?doc=health_service_schema

架构师之路 — API 经济 — Swagger & OpenAPI Specification
烟云的计算
09-09 2837
目录 文章目录目录Swagger 和 OpenAPIAPI 规范Design-First（设计优先）Code-First（编码优先）参考文档 Swagger 和 OpenAPI Swagger Specification 是一种 API Specification（API 规范），2015 年，SmartBear Software 将 Swagger Specification 捐赠给 Linux Foundation，并改称为 OpenAPI Specification，简称（OAS）。SmartBear
swagger:Swagger和ReDoc助手
04-30
Be.Vlaanderen.Basisregisters.AspNetCore.Swagger Swagger和ReDoc助手。 目标 提供一种简单的方法来配置项目以使用Swagger，并提供了很好的API文档。 快速贡献指南 在本地进行分叉和克隆。 使用Visual Studio， build.cmd或build.sh构建解决方案。 在git中创建主题特定的分支。 在代码中添加一个不错的功能。 不要忘记添加测试和/或文档。 运行build.cmd或build.sh以确保所有内容仍可编译且所有测试仍通过。 生成后，您将在./dist找到二进制文件，然后可以在本地进行测试，以确保错误或功能已成功修复/实现。 发送拉取请求。 快速开始 参考和或两者。 看一下示例项目。 浏览到您的API的根目录。 昂首阔步 特征 阅读汇编中的Swagger请求和响应示例。 将枚举描述为字符串。
swagger生成redoc文档
一个天蝎座的程序猿
02-26 9546
一、安装工具 npm install -g redoc-cli 二、生成文档 redoc-cli bundle -o index.html swagger.json { "openapi": "3.0.2", "info": { "title": "Workflow", "description": "API to access AnyShare\r\n\r\n如有任何疑问，可到开发者社区提问：https://developers.aishu.cn\r\n# Authentic
2025年API文档利器：10大Swagger替代工具全面解析
最新发布
gdjnrc_com的博客
02-21 1329
10 个好用的 Swagger 替代工具，包括Apifox、Postman、RapidAPI、Apiary、DapperDox、Redoc、Stoplight、Insomnia、SwaggerHub和Slate。
spring boot + swagger3 + redoc使用
鱼儿锅头的博客
04-23 1609
**} });} }/**} });} }/**} });} }/**} });} }Lists;} }/**} });/**} });} }
建立项目接口文档_在ASP.NET Core API项目中集成Swagger和带搜索的Redoc接口文档
weixin_28707535的博客
01-12 558
介绍swagger使我们在api开发中常用到的技术，其解决了web api文档生成的问题。它具有诸多交互式文档、客户端SDK生成和api可发现性等优点。由于笔者是从事.net core方向的开发，所以咱们就聊一聊在.net core web api的项目中集成swagger或者redoc。NSwag.NET本文主要讲的是使用NSwag.NET来将swagger集成到项目中来，包括swagger和r...
Laravel开发-l5-swagger-redoc
08-28
Laravel开发-l5-swagger-redoc 使用Rebilly Redoc用户界面轻松集成到Laravel 5。
Laravel集成l5-swagger与redoc API文档教程
在Laravel中，通过l5-swagger扩展包，开发者可以利用注释的方式来编写API描述，从而自动生产文档，而Redoc则提供了一种展示和交互文档的方式。 5. 交互式API文档 交互式API文档允许开发者和使用者直接在文档页面上...
sails-hook-swagger-generator：自动化生成Sails API的Swagger文档工具
- ReDoc：一个可以将Swagger规范文档转换为美观的交互式API文档的工具。 7. 压缩包子文件的文件名称列表 文件名称`sails-hook-swagger-generator-master`表明这是一个源代码仓库的根目录文件名，通常包含了工具的源...
redoc
03-08
Redoc 是一个开源的工具，专门用于生成美观、可浏览的API文档。它基于OpenAPI规范（也称为Swagger）来构建，旨在为开发者提供...在IT行业中，掌握如何有效使用Redoc和OpenAPI规范，是提升API开发和管理效率的关键技能。
fastapi：FastAPI框架，高性能，易于学习，快速编写代码，可投入生产
01-30
基于标准：基于（并完全兼容）API的开放标准： （以前称为Swagger）和 。 *根据内部开发团队的测试进行估算，以构建生产应用程序。 金牌赞助商 意见 “ [...]最近几天，我大量使用FastAPI 。[...]我实际上计划将其...
aiohttp-swagger3:使用swagger规范3.0进行swagger文档浏览和验证aiohttp请求的库
05-03
aiohttp-swagger3 关于 用于通过不同的UI后端显示swagger文档以及使用swagger规范3.0（称为OpenAPI3）可选地验证/解析aiohttp请求的软件包。 支持的UI后端 如果仅需要验证而无法查看文档，则可以使用多个UI后端，或者可以完全禁用UI后端。 Swagger UI- ReDoc- RapiDoc- 文献资料 https://aiohttp-swagger3.readthedocs.io/en/latest/ 禁用验证 将validate=False传递给SwaggerDocs / SwaggerFile类，默认值为True 另外，有时必须禁用路由验证，为此，您必须在路由初始化期间传递validate=False 。 前任。 web.post("/route", handler, validate=False) ，默认值为True 要
sample-api-docs:使用OpenAPI，Redocly和GitHub Pages的示例API文档
03-07
样本api文档 使用OpenAPI，Redocly和GitHub Pages的示例API文档
redoc-demo:ReDoc API文档平台演示
03-18
还原演示 ReDoc API文档平台演示
在 Azure Functions 中集成 Swagger 和 ReDoc：构建优雅的 API 文档
全栈开发
11-23 445
在 Azure Functions 中集成 Swagger 和 ReDoc：构建优雅的 API 文档
了解ReDoc
lmz_lmz的博客
07-20 7552
REDOC - OPENAPI-POWERED DOCUMENTATION UI   伊万·贡查罗夫     我们都喜欢SwaggerUI。这是Swagger / OpenAPI如此受欢迎的原因之一。最近API文档世界出现了一些新的趋势。其中之一是三面板设计文档。竞争的API规范格式有它们，例如API Blueprint有aglio，Postman有Postman Document...
Redoc 开源项目教程
gitblog_01085的博客
08-09 852
Redoc 开源项目教程 redoc???? OpenAPI/Swagger-generated API Reference Documentation项目地址:https://gitcode.com/gh_mirrors/re/redoc 1. 项目介绍 Redoc 是一个用于从 OpenAPI（前身为 Swagger）定义中生成美观API文档的开放源码工具。它提供了一个响应式的三面板布局：左侧是...
redoc 项目使用教程
gitblog_00008的博客
10-10 1032
redoc 项目使用教程 项目地址:https://gitcode.com/gh_mirrors/redo/redoc 1. 项目介绍 redoc 是一个用于实现 R Markdown 和 Microsoft Word 之间双向转换的 R 包。它能够生成可以反向转换回 R Markdown 的 Word 文档，保留 Word 文档中的编辑内容，包括跟踪的更改。redoc 目前处于暂停状态，但其核心...
IntelliJ IDEA 2023.2新特性详解第二弹！
JavaEdge全是干货的技术号
08-02 2797
IDEA 提供了对直接在 return 语句处设置断点的改进支持，类似已在 lambda 表达式中实现的设置方式。这一改进将为开发者提供更高的调试精度和更深入的代码分析，带来更有价值的代码行为和返回值洞察。当列表主要由字符串组成但包含布尔式文字时，IntelliJ IDEA 将高亮显示此文字，指示潜在的不一致，并建议为其添加引号。新工具将简化为团队生成共享索引的过程，只需几下点击，无需多个脚本和服务。）组成，则偏离此模式的任何文字都将被高亮显示为可能的错误，不过，在这种情况下不会建议具体的快速修复。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值