码迷,mamicode.com
首页 > Windows程序 > 详细

Swagger生成WebAPI文档

时间:2017-02-21 12:42:14      阅读:270      评论:0      收藏:0      [点我收藏+]

标签:sem   ase   程序包管理   访问   blog   art   UI   控制   使用   

最近在做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文档

标签:sem   ase   程序包管理   访问   blog   art   UI   控制   使用   

原文地址:http://www.cnblogs.com/renyiqiu/p/6423535.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!