感谢JetBrains 支持

OpenSourceSupport

swagger2md

假如你编写了一个基于OpenAPI3.0规范 的WebAPI现在正想着如何编写文档以便于他人更方便调用它，那么swagger2md可以帮助你

功能特性

• 将swagger.json生成markdown文档
• 请求参数example展示
• 请求body json格式化
• 返回response json格式化
• 大纲展示
• 接口summary展示
• 接口remark展示
• 接口参数字段展示
• 接口reponse 字段展示

软件架构(可选)

.NET 6

快速开始

open OpenAPI2MD.CommunityToolkit.sln with vs

依赖检查

dotnet restore

构建

dotnet build

运行

dotnet run

使用指南

• 安装msi

  双击运行Swagger2Md.msi

• dotnet install

  dotnet tool install --global Swagger2Doc --version 1.0.0

• 调用

  在目录中打开cmd窗口运行命令

  

• Swagger2Md + swagger.json 的 url

  

• 查看

  打开swagger.json

  

如何贡献

star -> fork -> pull request

关于作者

name:master never down email:13126506430@1163.com

谁在用(可选)

maybe next is you

许可证

MIT