swagger简单配置

原文链接: http://www.cnblogs.com/LiChen19951127/p/10310412.html

 

第一步:

nuget.org中查找Swashbuckle并下载

 swagger简单配置_第1张图片

 

 

 

nuget.org中查找Swagger.net.UI,并下载

 swagger简单配置_第2张图片

 

       

第二步:

下载完之后,App_Start多了三个文件

Swagger.Auth.cs

SwaggerConfig.cs

SwaggerNet.cs

SwaggerNet.cs删除,没用的cs文件

 swagger简单配置_第3张图片

 

 swagger简单配置_第4张图片

 

 

第三步:

配置:SwaggerConfig.cs

c.IncludeXmlComments(string.Format("{0}/bin/SwaggerDemo.XML", System.AppDomain.CurrentDomain.BaseDirectory));

 

放在 GlobalConfiguration.Configuration

                .EnableSwagger(c =>

                    {}

当中

 swagger简单配置_第5张图片

 

 

 

第四步:

点击项目下的小扳手

找到生成中的输出,勾选XML文档文件,将文件名改为与上一步当中的XML文件名一致

 swagger简单配置_第6张图片

 

将禁止显示警告设为1591,不然会警告没有设置XML文档注释,保存即可

 swagger简单配置_第7张图片

 

成果显示:默认的路径就是http://localhost:56708/swagger(api路径/swagger)

 swagger简单配置_第8张图片

 

最后一步

只需加上注释即可

注意:注释必须使用文档注释,///

 swagger简单配置_第9张图片

swagger简单配置_第10张图片

 

 

可以直接测试数据,s输入ID,点击Try it out

 swagger简单配置_第11张图片

 

 

最终效果

 swagger简单配置_第12张图片

 

转载于:https://www.cnblogs.com/LiChen19951127/p/10310412.html

你可能感兴趣的:(swagger简单配置)