以下为教程:

在现有webapi项目中,nuget安装以下两个插件

swagger.net.ui

swashbuckle

安装完毕后可以卸载Swagger.NET,此处不需要!

安装完毕后屏蔽以下代码

直接运行调试

在浏览器的目录后面加上/swagger即可跳转到swagger调试页

此时如果没有注释.

项目属性里添加xml注释的生成

修改App_Start下的SwaggerConfig.cs文件

添加如下代码

            GlobalConfiguration.Configuration.EnableSwagger(c =>{c.IncludeXmlComments(GetXmlCommentsPath());
......
}

  protected static string GetXmlCommentsPath(){return System.String.Format(@"{0}\bin\你的xml文件名.XML", System.AppDomain.CurrentDomain.BaseDirectory);}

此时重新生成浏览可以获取正确的注释并调试了.

异常解决

报错

webapi 配置swagger出现问题：

Swagger Not supported by Swagger 2.0: Multiple operations with path 解决方法

一个controller中只能有一个HttpGet请求，多了就会报错。建议减少重载方法，将其他Get方法分开

如果在swagger.config中加上c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First());则会只显示第一个get方法

加了上面的方法后,get可能会只显示一条记录

WebAPI 默认只支持一个get方法,支持多个Get需要修改

RouteConfig文件

   routes.MapRoute(name: "Default",url: "{controller}/{action}/{id}",defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional });

因此,需要对swagger.net也添加相应的支持.（无效）

 public static void RegisterRoutes(RouteCollection routes){routes.IgnoreRoute("{resource}.axd/{*pathInfo}");RouteTable.Routes.MapHttpRoute(name: "SwaggerApi",routeTemplate: "api/docs/{controller}/{action}",defaults: new { swagger = true });routes.MapRoute(name: "Default",url: "{controller}/{action}/{id}",defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional });}

以上，均非有效解决办法，正确的办法入戏：

config.Routes.MapHttpRoute(name: "DefaultApi",//   routeTemplate: "api/{controller}/{id}",routeTemplate: "api/{controller}/{action}/{id}",//defaults: new { id = RouteParameter.Optional }defaults: new { controller = "Home", action = "Index", id = RouteParameter.Optional });

完成

异常3

fetching resource list: http://localhost:8011/swagger/docs/v1; Please wait.

一直显示这个界面

只返回Json Result的content negotiation代替Web Api中默认的content negotiation造成的.

WebApiConfig中，行：

config.Services.Replace(typeof(IContentNegotiator), new JsonContentNegotiator(jsonFormatter));

临时屏蔽即可

【转】ASP.NET Web API 使用Swagger生成在线帮助测试文档,支持多个GET相关推荐

ASP.NET Web API 使用Swagger生成在线帮助测试文档
ASP.NET Web API 使用Swagger生成在线帮助测试文档 Swagger-UI简单而一目了然.它能够纯碎的基于html+javascript实现,只要稍微整合一下便能成为方便的API在线 ...
SpringBoot集成swagger生成在线接口文档
SpringBoot集成swagger生成在线接口文档集成maven依赖 <dependency><groupId>io.springfox</groupId>& ...
ASP.NET Web API自身对CORS的支持：从实例开始
在<通过扩展让ASP.NET Web API支持W3C的CORS规范>中我们通过自定义的HttpMessageHandler为ASP.NET Web API赋予了跨域资源共享的能力,具体来 ...
Swagger+Spring mvc生成Restful接口文档
2019独角兽企业重金招聘Python工程师标准>>> Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端 ...
ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了
引言在使用asp.net core 进行api开发完成后,书写api说明文档对于程序员来说想必是件很痛苦的事情吧,但文档又必须写,而且文档的格式如果没有具体要求的话,最终完成的文档则完全取决于开发者 ...
生成用于ASP.NET Web API的C＃客户端API
目录介绍主要特征主要好处背景推定(Presumptions) 使用代码步骤0:将NuGet软件包WebApiClientGen安装到Web MVC/API项目步骤1:建立.NET Cli ...
【转】ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了
原文链接:https://www.cnblogs.com/yilezhu/p/9241261.html 引言在使用asp.net core 进行api开发完成后,书写api说明文档对于程序员来说想必 ...
生成用于ASP.NET Web API的TypeScript客户端API
目录介绍备注背景推定(Presumptions) 使用代码步骤0:将NuGet package WebApiClientGen和WebApiClientGen.jQuery安装到Web AP ...
WCF 和 ASP.NET Web API
地址:https://docs.microsoft.com/zh-cn/dotnet/framework/wcf/wcf-and-aspnet-web-api WCF 是 Microsoft 为生成面 ...

【转】ASP.NET Web API 使用Swagger生成在线帮助测试文档,支持多个GET

异常解决

【转】ASP.NET Web API 使用Swagger生成在线帮助测试文档,支持多个GET相关推荐

最新文章

热门文章