首页 > 代码库 > Swagger生成WebAPI文档

Swagger生成WebAPI文档

2024-09-05 05:39:36   218人阅读

最近在做WebAPI2.0 项目，为了使用者能轻易查看API文档，因此使用Swagger进行了配置

 

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

Install-Package Swashbuckle

技术分享

 

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文档文件）->保存

技术分享

 

5.最后就是访问地址了

http://localhost:82/swagger/ui

 

技术分享

 

Swagger生成WebAPI文档


联系
我们