ReDoc最完善的API文档
2022/6/3 23:21:52
本文主要是介绍ReDoc最完善的API文档,对大家解决编程问题具有一定的参考价值,需要的程序猿们随着小编来一起学习吧!
开启swagger注释
-
项目设置勾选“文档文件”
-
加载文档文件
builder.Services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new OpenApiInfo { Title = "天气查询说明", Version = "v2" }); //启用中文注释功能 var basePath = AppContext.BaseDirectory; var xmlPath = Path.Combine(basePath, "ReDocExample.xml"); c.IncludeXmlComments(xmlPath, true); });
添加接口注释及ProducesResponseType
- 添加Remarks注释,可以更详细描述文档内容
- ProducesResponseType可以让调用者更清楚接口不同状态下返回的接口数据格式
swagger.json转swagger.yaml
- https://oktools.net/json2yaml
使用以上工具将swagger.json转为openapi.yaml文件
将部署Redoc 文档服务
- Github上clone Redoc项目
Redoc地址: https://github.com/Redocly/redoc
- 将 openapi.yaml 复制到demo目录中
-
运行npm run start
-
Redoc效果
完美的文档样式,再也不用文档发愁了
示例代码地址
- https://github.com/huzuohuyou/DotNet6-Examples.git
这篇关于ReDoc最完善的API文档的文章就介绍到这儿,希望我们推荐的文章对大家有所帮助,也希望大家多多支持为之网!
- 2024-05-15PingCAP 黄东旭参与 CCF 秀湖会议,共探开源教育未来
- 2024-05-13PingCAP 戴涛:构建面向未来的金融核心系统
- 2024-05-09flutter3.x_macos桌面os实战
- 2024-05-09Rust中的并发性:Sync 和 Send Traits
- 2024-05-08使用Ollama和OpenWebUI在CPU上玩转Meta Llama3-8B
- 2024-05-08完工标准(DoD)与验收条件(AC)究竟有什么不同?
- 2024-05-084万 star 的 NocoDB 在 sealos 上一键起,轻松把数据库编程智能表格
- 2024-05-08Mac 版Stable Diffusion WebUI的安装
- 2024-05-08解锁CodeGeeX智能问答中3项独有的隐藏技能
- 2024-05-08RAG算法优化+新增代码仓库支持,CodeGeeX的@repo功能效果提升