使用Swagger记录ASP.NET Web API

使用Swagger记录ASP.NET Web API

原文作者：Rob Sanders

原文地址：https：//dzone.com/articles/documenting-a-aspnet-web-api-with-swagger

在本文中，我将介绍一些可以为ASP.NET Web API生成文档的方法。除非您从未生成过Web API网站，否则您将会意识到，默认模板已经包含了为您可能实现的API 生成文档的功能，其中的一个示例位于authme.ws。

入门

没有什么比一对夫妇的文章更多的已写入有关如何生成使用扬鞭用于ASP.NET的Web API文档（这里面的NuGet包称为Swashbuckle，你可以轻松地集成），但我需要的东西少动-其实，我需要生成表示我们提升到生产（即时间点）的静态文档，因为它需要提供给审计。

传统的文档（例如Sandcastle Help File Builder）显然不可行，因为它记录了托管代码，而不是更重要的API接口和运行时模型。

幸运的是，有一个工具集称赞Swagger，称为Swagger codegen，它生成客户端代码来使用API​​，对于我来说 - 生成静态HTML的能力（礼貌[1]）。不幸的是，我找不到Swagger Codegen ，所以我咬紧牙关，使用Maven和最新的JDK 从源代码编译Java二进制文件。

你需要什么

您需要能够生成可以在IIS或IIS Express中启动的Web API站点。理想情况下，你要做的是将前面提到的Swashbuckle NuGet包集成到你现有的（或新的）Web API项目中。安装完成后，您只需更改项目设置即可生成注释XML文件（不是强制性步骤，但非常有用 - 请参阅下图），然后配置插入App_Startup文件夹下项目的SwaggerConfig.cs文件。

image.png