Swagger2Doc 1.0.3
dotnet tool install --global Swagger2Doc --version 1.0.3
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest # if you are setting up this repo dotnet tool install --local Swagger2Doc --version 1.0.3
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=Swagger2Doc&version=1.0.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
nuke :add-package Swagger2Doc --version 1.0.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
感谢JetBrains 支持
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
安装2
dotnet tool install --global Swagger2Doc升级
dotnet tool update Swagger2Doc -g --version 1.0.3卸载
dotnet tool uninstall Swagger2Doc调用
在目录中打开cmd窗口运行命令
swagger2doc -t md -s http://localhost:18100/swagger/3.0.0/swagger.jsonSwagger2Md + swagger.json 的 url
查看
打开swagger.json
如何贡献
star → fork → pull request
关于作者
name:master never down email:13126506430@1163.com
谁在用(可选)
maybe next is you
许可证
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
This package has no dependencies.