ASP.NET Web API 使用Swagger使用筆記
https://www.cnblogs.com/lhbshg/p/8711604.html
最近換了工作，其中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
程式碼：
按 Ctrl+C 複製程式碼 按 Ctrl+C 複製程式碼
第二步：定義一個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：
上程式碼：
1 /// <summary>
2 /// swagger 增加 AUTH 選項
3 /// </summary>
4 public class HttpAuthHeaderFilter : IOperationFilter
5 {
6 /// <summary>
7 /// 應用
8 /// </summary>
9 /// <param name="operation"></param>
10 /// <param name="schemaRegistry"></param>
11 /// <param name="apiDescription"></param>
12 public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
13
14 {
15 if (operation.parameters == null)
16 operation.parameters = new List<Parameter>();
17 var filterPipeline = apiDescription.ActionDescriptor.GetFilterPipeline(); //判斷是否新增許可權過濾器
18 var isAuthorized = filterPipeline.Select(filterInfo => filterInfo.Instance).Any(filter => filter is IAuthorizationFilter); //判斷是否允許匿名方法
19 var allowAnonymous = apiDescription.ActionDescriptor.GetCustomAttributes<AllowAnonymousAttribute>().Any();
20 if (isAuthorized && !allowAnonymous)
21 {
22 operation.parameters.Add(new Parameter { name = "Authorization", @in = "header", description = "安全", required = false, type = "string" });
23 }
24 }
25 }
SwaggerConfig.cs 配置中加入 c.OperationFilter<HttpAuthHeaderFilter>();
看效果 可以 開始測試吧，可問題又來了 難道要對著實體物件編一個JSON物件，不用下一個我們來做個請求示例，繼續...
7.請求示例remarks
先看個效果：
要想實現這個效果 ，我們需要使用呢remarks 看寫法吧，需要說明的是 <remarks>前有個空格 請求地址 空格+tab 才能出來上面效果
/// <summary>
/// 記錄日誌
/// </summary>
/// <remarks>
/// 日誌請求示例
///
/// Post Api/Subject/Log
///
/// {
/// "subjectId":100012,
/// "mouldId":0,
/// "statType":"10",
/// "entityId":0,
/// "viewUserId":1,
/// "ip":"127.0.0.1",
/// "devId":"1111",
/// "source":1
/// }
/// </remarks>
/// <param name="model"></param>
/// <returns></returns>