一切福田,不離方寸,從心而覓,感無不通。

ASP.NET Web API 使用Swagger使用笔记

最近换了工作,其中Webapi这块没有文档,之前有了解过Swagger借此机会好好整理下常用的地方分享给有需要的小伙伴。

概述:

1.swagger 引用
2.swagger 问题1.action 方法名称相同处理
3.swagger 问题2.序列化出来的JSON NULL 值处理
4. 汉化及controller说明
5. 统一返回HttpResponseMessage 返回类型 指定
6. 自定义 HTTP Header (oauth2.0 请求)
7.请求示例remarks

 

1.swagger 引用

 第一步:

 

第二步:修改SwaggerConfig.cs

如 api 版本号,title

 

第三步:创建项目XML注释文档

右键项目→属性→生成→选中下方的 "XML文档文件" 然后保存

配置启用:

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

第四步:启动项目

地址:http://localhost:58303/swagger

 

哈哈 成功了,不对这个是最终效果,下面一步一步来实现吧。
2.swagger 问题1.action 方法名称相同处理

根据错误提示 很快发现 某位大神 同样的接口名 传递了不同参数,导致了这个错误,解决方式:

c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First());

问题解决了 进行下一步
3.swagger 问题2.序列化出来的JSON NULL 值处理

先上图

等了好半天 一直不出来 打开F12一看原来有错,万能的网友帮了我,原来问题出在http://localhost:58303/swagger/docs/v1这个JSON资源上面,

序列化出来的JSON,包含了为NULL的字段,导致swagger-ui-min-js出现异常。

进一步分析是因为我项目使用的newtonsoft.json这个库的配置导致,应该忽略为NULL的字段,

对应解决办法如图: settings.NullValueHandling = NullValueHandling.Ignore;

 

问题解决了 开心 继续…
4. 汉化及controller说明

看图:咦 怎么控制器没有说明,这个和汉化一起说吧

第一步:定义一个provider实现ISwaggerProvider接口 包含了缓存 名:SwaggerCacheProvider

代码:

 

第二步:定义一个JS文件,做成嵌入资源,这个js文件的功能主要有两个,一个是汉化,另一个就是在界面上显示控制器的描述文字

 

第三步:修改App_Start中的SwaggerConfig.cs文件,主要代码有两行

c.CustomProvider((defaultProvider) => new SwaggerCacheProvider(defaultProvider, string.Format("{0}/bin/BjxWebApis.XML", System.AppDomain.CurrentDomain.BaseDirectory)));

c.InjectJavaScript(System.Reflection.Assembly.GetExecutingAssembly(), "BjxWebApis.swagger.js");

JS资源文件命名空间是:文件所在项目的命名空间.文件径路.文件名

执行:

 

汉化有了 但是控制器说明没有,经过排查发现 var summaryDict = data.ControllerDesc; 没有获取到对象

使用var summaryDict = data.vendorExtensions.ControllerDesc;

再试,成功了,继续下一个目标,返回类型指定

 
5. 统一返回HttpResponseMessage 返回类型 指定

很多时候我们会使用HttpResponseMessage  作为返回对象 很方便,但是Swagger 不知道我们具体返回啥,它不看我们的业务代码!!

直接上干货,使用SwaggerResponse 指定返回类型,两个httpstatuscode 对应不同返回值

看下效果

 

是不是想马上试试,可是问题又来了 接口有用户验证,没关系,继续看下一个

6. 自定义 HTTP Header (oauth2.0 请求)

在开发API时常常需要验证权限,验证参数放在Http请求头中是再好不过了。WebAPI配合过滤器验证权限即可

首先我们需要创建一个 IOperationFilter 接口的类。IOperationFilter:

上代码:

SwaggerConfig.cs 配置中加入  c.OperationFilter<HttpAuthHeaderFilter>();

看效果 可以 开始测试吧,可问题又来了 难道要对着实体对象编一个JSON对象,不用下一个我们来做个请求示例,继续…
7.请求示例remarks

先看个效果:

 

要想实现这个效果 ,我们需要使用呢remarks 看写法吧,需要说明的是 <remarks>前有个空格  请求地址 空格+tab 才能出来上面效果

 

总结:

规范化api的编写和注释,以及标准化文档,对于团队的开发效率有很大的提升,也有利于项目的维护。使用在线接口文档后,方便前后端工程师沟通,测试人员测试只需要在页面输入参数,点击调用就可以看到调用结果。

第一次写博客用了很长时间(将近3个小时)才写完,肯定会有很多不足,同时也深深觉得那些在园子里无私奉献的伙伴的辛苦,感谢他们!!!

 

from:https://www.cnblogs.com/lhbshg/p/8711604.html