Swagger2Md:让WebAPI文档生成变得轻松高效

Swagger2Md:让WebAPI文档生成变得轻松高效

在当今数字化时代,WebAPI的开发与使用日益频繁。如何让他人更便捷地调用我们编写的基于OpenAPI 3.0规范的WebAPI呢?Swagger2Md应运而生,它能够将swagger.json转化为清晰易读的markdown文档,极大地简化了文档编写流程。

功能特性

  • 文档转换:将swagger.json生成markdown文档,方便在各种支持markdown的平台展示。
  • 参数展示:请求参数example展示,让使用者清楚了解每个参数的示例值。
  • 格式化处理:请求body json格式化以及返回response json格式化,使代码结构更清晰。
  • 大纲与总结:提供大纲展示、接口summary展示和接口remark展示,快速把握接口核心信息。
  • 字段展示:接口参数字段展示和接口response字段展示,详细呈现接口数据结构。
  • 架构支持可选支持.NET 6架构。

快速开始

  1. 打开OpenAPI2MD.CommunityToolkit.sln项目文件,使用Visual Studio进行开发环境搭建。
  2. 进行依赖检查,运行dotnet restore命令,确保项目依赖项完整。
  3. 构建项目,执行dotnet build命令,编译生成可执行文件。
  4. 启动程序,通过dotnet run命令,开始使用Swagger2Md。

使用指南

  • 安装

    • 双击运行Swagger2Md.msi文件进行安装。
    • 或者使用命令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.json,指定swagger.json的url进行文档生成。

  • 查看:打开swagger.md文件,查看API的详细信息。

  • PDF:可以在vscode中将markdown文档导出PDF

    • 安装Markdown Preview Enhanced

    • 在预览页面右键导出PDF

如何贡献

欢迎各位开发者参与Swagger2Md的开源项目,通过以下步骤贡献代码:

  1. 对项目进行star,表示关注与支持。
  2. fork项目到自己的仓库,进行代码修改与优化。
  3. 提交pull request,将改进的代码合并回主项目。

关于作者

  • 姓名:master never down
  • 邮箱:13126506430@1163.com

谁在用

或许下一个使用Swagger2Md的人就是你,它适用于各类需要高效生成WebAPI文档的开发者和团队。

许可证

本项目采用MIT许可证,允许在遵循许可证条款的前提下自由使用、修改和分发代码。

感谢JetBrains对开源项目的支持,让我们能够更好地推动技术发展与共享。Swagger2Md致力于为WebAPI文档生成提供简洁高效的解决方案,期待与更多开发者共同进步,让文档编写不再是难题。

相关推荐
加号37 小时前
【C#】获取电脑网卡MAC地址
windows·c#
yi碗汤园7 小时前
【超详细】C#自定义工具类-StringHelper
开发语言·前端·unity·c#·游戏引擎
sali-tec7 小时前
C# 基于halcon的视觉工作流-章49-网面破损
开发语言·图像处理·算法·计算机视觉·c#
YuanlongWang8 小时前
c# ABP vNext 框架详解及其模块化开发思想介绍
开发语言·c#
张人玉8 小时前
WPF布局控件(界面骨架核心)
开发语言·c#·wpf·布局控件
刘欣的博客11 小时前
C# 上传票据文件 调用Dify的API完成OCR识别
c#·ocr·api·dify
hoiii18711 小时前
C#实现近7天天气预报
开发语言·c#
亦陈不染11 小时前
c#入门详解(刘铁锰)06 - 数据持久化:TXT文本保存、序列化与反序列化(附详细源码)
开发语言·计算机视觉·c#·wpf
忧郁的蛋~16 小时前
.NET实现多任务异步与并行处理的详细步骤
后端·c#·asp.net·.net·.netcore
阿登林16 小时前
C# iText7与iTextSharp导出PDF对比
开发语言·pdf·c#