WebApi中Swagger的使用（超级简单）

Swagger解释

Swagger是一种Rest API的简单但强大的表示方式，她是标准的与语言无关，这种表示方式不但人可读，而且机器可读。 可以作为Rest API的交互式文档，也可以作为Rest API的形式化的接口描述，生成客户端和服务端的代码。

Swagger能成为最受欢迎的REST APIs文档生成工具的原因

Swagger 可以生成一个具有互动性的API控制台，开发者可以用来快速学习和尝试API。
Swagger 可以生成客户端SDK代码用于各种不同的平台上的实现。
Swagger 文件可以在许多不同的平台上从代码注释中自动生成。
Swagger 有一个强大的社区，里面有许多强悍的贡献者。

在.NET中Web Api中的使用

1. NuGet上引用Swashbuckle（5.6.0）
2. 项目右键项目属性 》 生成 》 XML文档文件（建议直接项目名.xml,方便下一步的xml的获取）
3. SwaggerConfig中修改c.IncludeXmlComments(commentsFile)，以便于action上注释的显示

var baseDirectory = AppDomain.CurrentDomain.BaseDirectory;
var commentsFileName = Assembly.GetExecutingAssembly().GetName().Name + ".XML";
var commentsFile = Path.Combine(baseDirectory, commentsFileName);
c.IncludeXmlComments(commentsFile);

4. 运行，http://localhost:端口/swagger/ui/index

5.效果如图

转载于:https://www.cnblogs.com/zhao123/p/9269124.html