面向web api开发大家在开发完 webapi 后，经常为了方便接口双方对接，需要将 webapi 接口文档化，那有没有什么快捷可交互的文档呢？可以利用快捷工具 Swagger，它的可视化 UI 可轻松助你 API 文档化的同时还方便测试 API。
Swashbuckle 就是一个用于生成 Swagger 文档的开源工具包，这篇文章将会讨论如何利用 Swashbuckle 来为你的 Restful API 生成可交互的文档。
Swagger 是一个规范且完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。 Swagger 的目标是对 REST API 定义一个标准且和语言无关的接口，可以让人和计算机拥有无需访问源码、文档或网络流量监测就可以发现和理解服务的能力。当通过 Swagger 进行正确定义，用户可以理解远程服务并使用最少实现逻辑与远程服务进行交互。与为底层编程所实现的接口类似，Swagger 消除了调用服务时可能会有的猜测。
Swagger 的优势
支持 API 自动生成同步的在线文档：使用 Swagger 后者可以直接通过代码生成文档，不再需要自己手动编写接口文档了，对程序员来说非常方便，可以节约写文档的时间去学习新技术。提供 Web 页面在线测试 API：光有文档还不够，Swagger 生成的文档还支持在线测试。参数和格式都定好了，直接在界面上输入参数对应的值即可在线测试接口。说白了就是一种接口文档，而且支持在线调试，从而提升web api开发的效率。 其它同类型的工具还有apidoc,如：https://code.z01.com/apidoc/ 就是用apidoc生成，可以检索、遍历，缺点是不能调试。 来自Java开源社区的Swagger则功能更加强大，自然受人欢迎。
一句话： dotNET CORE Swagger的使用，写好注释就是写好接口文档
其运界面如下所示：
什么是OAS3作为一个经常要提供给API文档给内部和第三方的阅读的“苦程”，我一直在寻找一个完美的Spring MVC文档解决方案。过去，我一直使用的是springfox-swagger2依赖，使用swagger2注解，对代码进行注释，生成swagger文档。 不过，早在2020年Swagger2就已过时，springfox-swagger2也已停止维护。业界普遍转向了OAS3 规范管理文档接口，这也是当前OpenApi规范标准。
自2021年5月1日起，逐浪CMS全线产品提供Swagger和OAS3规范，全面支持移动开发，拥有开放的力量。
扩展阅读：https://www.z01.com/cli/build/%E5%9F%BA%E4%BA%8EdotNET-5-MVC%E7%BB%8F%E5%85%B8%E6%A8%A1%E5%BC%8F%E5%BC%95%E5%85%A5Swagger%E8%BF%9B%E8%A1%8Cweb-api%E5%BC%80%E5%8F%91%E5%92%8C%E7%AE%A1%E7%90%86%E5%8F%91%E5%B8%83OAS3%E6%A0%87%E5%87%86%E6%8E%A5%E5%8F%A3%E6%96%87%E6%A1%A3%E5%85%A8%E8%BF%87%E7%A8%8B.html
021-50391046