Swagger生成WebAPI文档

时间:2021-12-18 17:14:48

WebAPI2.0 项目可以使用Swagger能够轻易查看API文档,查看以下配置

1.打开程序包管理控制台输入:

Install-Package Swashbuckle

Swagger生成WebAPI文档

2.在对应项目里的App_Start文件夹下的SwaggerConfig.cs文件找到:

c.IncludeXmlComments 

然后进行替换

c.IncludeXmlComments(GetXmlCommentsPath(thisAssembly.GetName().Name));

3.然后再与Register方法平级的地方增加一个方法

        protected static string GetXmlCommentsPath(string name)
{
return string.Format(@"{0}\bin\{1}.XML", AppDomain.CurrentDomain.BaseDirectory, name);
}

4.右键项目->属性->生成->勾选(XML文档文件)->保存

Swagger生成WebAPI文档

5.最后就是访问地址了

http://localhost:82/swagger/ui

Swagger生成WebAPI文档