1 Star 3 Fork 1

master never down / OpenAPI2MD.CommunityToolkit

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

感谢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

使用指南

  • 安装

    双击运行Swagger2Md.msi

  • 调用

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

  • Swagger2Md + swagger.json 的 url

  • 查看

    打开swagger.json

如何贡献

star -> fork -> pull request

关于作者

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

谁在用(可选)

maybe next is you

许可证

MIT

MIT License Copyright (c) 2022 喜爱糖葫芦 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

swagger.json 生成markdown文档命令行工具 展开 收起
C#
MIT
取消

贡献者

全部

近期动态

加载更多
不能加载更多了
C#
1
https://gitee.com/galacode/OpenAPI2MD.CommunityToolkit.git
git@gitee.com:galacode/OpenAPI2MD.CommunityToolkit.git
galacode
OpenAPI2MD.CommunityToolkit
OpenAPI2MD.CommunityToolkit
main

搜索帮助

53164aa7 5694891 3bd8fe86 5694891