如何利用Swagger在ASP.NET Core中构建API文档？

本文共计2033个文字，预计阅读时间需要9分钟。

在软件开发过程中，我们常采用前后端分离的开发模式。在这种模式下，前后端开发人员协同工作，后端人员需提供API文档以供前端人员使用。

在实际的软件开发过程中，我们通常会采用一种前后端分离的开发模式，在这种模式下一般会由前后端两类开发人员协同开发，在这种情况下后端开发人员则需要提供API文档去与前端人员进行对接，这样才能保障后续的工作能够顺利开展。

并且当前项目在与外部系统进行业务往来或者数据交互的时候，我们通常会作为“接口方”对外提供数据，这种情况下我们通常也会需要后端开发人员去针对接口编写API文档。另外，在API接口开发完成后，我们的测试人员还要单独下载第三方接口测试工具对API接口进行测试。

那么基于以上的应用场景的痛点，本文将推荐一个既方便又美观的接口文档框架——Swagger。

使用 Swagger 后，项目可以直接通过API代码生成文档，不再需要自己手动编写接口文档，对开发者来说非常方便，以此便可节约写文档的时间去产出更多的东西。不光如此，Swagger 还提供 Web 页面，可在线测试 API的共，参数和格式都定好了，直接在界面上输入对应的值，即可在线测试接口。

---

1.使用Swagger

通常在项目中引用Swagger组件有两种方式：一种是直接在网上下载到对应的类库文件，另一种是通过NuGet包进行添加。下面主要介绍如何通过NuGet进行引用。