WebAPI纯净版中增加Swagger

Posted erricshih

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了WebAPI纯净版中增加Swagger相关的知识,希望对你有一定的参考价值。

WebAPI纯净版的基础上

  • 添加nuget包   a). Swashbuckle    b). Swagger.Net.UI

技术分享图片

技术分享图片

  • 取消文件SwaggerConfig.cs中 c.IncludeXmlComments(GetXmlCommentsPath());的注释
  • 并在此类中添加方法:GetXmlCommentsPath()
1 private static string GetXmlCommentsPath()
2         {
3             return string.Format(@"{0}inWebApi.XML", AppDomain.CurrentDomain.BaseDirectory);
4         }

技术分享图片

  • binWebApi.XML这个路径的由来:

技术分享图片

 

  • 注释掉SwaggerNet.cs文件中的部分代码,见下图

技术分享图片

  • 运行工程:

技术分享图片

技术分享图片

以上是关于WebAPI纯净版中增加Swagger的主要内容,如果未能解决你的问题,请参考以下文章

Swagger 增加 DocumentFilter 隐藏不需要显示的接口

.NetCore2.1 WebAPI 根据swagger.json自动生成客户端代码

MVC WebApi Swagger帮助文档 接口用法

[经验分享]WebApi+SwaggerUI 完美展示接口

在webapi中使用swagger

第一个webapi及swagger