WebApi怎样配置Swagger

1、在Nuget中引入Swashbuckle、Swagger.Net.UI，安装成功后会在App_Start文件夹中生成两个Swagger配置文件SwaggerConfig.cs和SwaggerNet.cs

 

2、打开Xml文件，右键WebApi项目，选择属性，然后在生成栏勾选XML文档文件

 

3、运行项目，在端口后输入/swagger/ui/index发现项目会报错

 

4、打开App_Start中的SwaggerNet.cs文件，注释下面这两行代码。

 

5、再次运行项目则发现Swagger已经可以使用了

 

6、添加注释，在SwaggerConfig.cs中找到c.SingleApiVersion，然后在它下面加上如下代码：

c.IncludeXmlComments(GetXmlCommentsPath());

在SwaggerConfig.cs中添加一个GetXmlCommentsPath方法（其中的/bin/SwaggerDemo.xml是【步骤2】中的XML文档文件路径）：

//添加XML解析
private static string GetXmlCommentsPath()
{
    return string.Format("{0}/bin/SwaggerDemo.xml", System.AppDomain.CurrentDomain.BaseDirectory);
}    

 

接下来运行项目就能看到我们写的接口参数注释了

 

转载自：https://home.cnblogs.com/u/2018clg/