隨着技術的不斷發展，網站框架也開始向：前后端分離的形態發展，而且前端技術和后端技術在各自的道路上越走越遠。而web api 接口成了前后端唯一的聯系。所以web api會變得越來越重要。
那么什么是Web Api呢？
主要有兩點 1.可以對接各種客戶端（瀏覽器，移動設備）
2.構建http服務的框架。
而我們今天要學的Swagger是一款可以讓你更好的開發api的框架。
關於 Swagger
Swagger能成為最受歡迎的REST APIs文檔生成工具之一，有以下幾個原因：
- Swagger 可以生成一個具有互動性的API控制台，開發者可以用來快速學習和嘗試API。
- Swagger 可以生成客戶端SDK代碼用於各種不同的平台上的實現。
- Swagger 文件可以在許多不同的平台上從代碼注釋中自動生成。
- Swagger 有一個強大的社區，里面有許多強悍的貢獻者。
Swagger實戰
1.創建WebApi項目：直接新建項目》ASP.NET Web應用程序》Web Api。就可以創一個web api模板，直接運行，查看api接口。我們可以從下圖看出默認的api管理不是很方便，而且看起來丑爆了。
2.接下來就是使用Swagger，首先是安裝Swagger，打開管理Nuget程序包，搜索swashbuckle，選中安裝即可。
3.安裝成功后，選中項目后右鍵屬性》生成》勾選輸出.XML文檔文件，然后保存。運行項目就會生成文件bin\Swagger.Web.Api.xml。（這一步很重要）
4.接下來配置App_Start文件夾里SwaggerConfig.cs文件，如下圖所示；
public class SwaggerConfig { public static void Register() { var thisAssembly = typeof(SwaggerConfig).Assembly; GlobalConfiguration.Configuration .EnableSwagger(c => { c.SingleApiVersion("v1", "Swagger.Web.Api"); c.IncludeXmlComments(GetXmlCommentsPath()); }) .EnableSwaggerUi(c => { c.DocumentTitle("My Swagger UI"); }); } /// <summary> /// 獲取xml文件 /// </summary> /// <returns></returns> protected static string GetXmlCommentsPath() { return System.String.Format(@"{0}\bin\Swagger.Web.Api.xml", System.AppDomain.CurrentDomain.BaseDirectory); } }
5.還有要修改默認打開路徑，設置為直接打開swagger。
6.運行項目，完美顯示接口。詳細用法，自己摸索就行了，沒有什么難度。
Swagger漢化
1.創建文件swaggger_lang.js,路徑位置可以參考下圖。(注意swaggger_lang.js的屬性》生成操作：設置為嵌入的資源，因為swagger里的資源都是嵌入到dll里的，我們常用的資源文件都是以內容的方式放在項目中的，我們也可以以嵌入的資源方式引入到項目中)
/// <summary> /// 中文轉換 /// </summary> var SwaggerTranslator = (function () { //定時執行檢測是否轉換成中文,最多執行500次 即500*50/1000=25s var iexcute = 0, //中文語言包 _words = { "Warning: Deprecated": "警告：已過時", "Implementation Notes": "實現備注", "Response Class": "響應類", "Status": "狀態", "Parameters": "參數", "Parameter": "參數", "Value": "值", "Description": "描述", "Parameter Type": "參數類型", "Data Type": "數據類型", "Response Messages": "響應消息", "HTTP Status Code": "HTTP狀態碼", "Reason": "原因", "Response Model": "響應模型", "Request URL": "請求URL", "Response Body": "響應體", "Response Code": "響應碼", "Response Headers": "響應頭", "Hide Response": "隱藏響應", "Headers": "頭", "Try it out!": "試一下！", "Show/Hide": "顯示/隱藏", "List Operations": "顯示操作", "Expand Operations": "展開操作", "Raw": "原始", "can't parse JSON. Raw result": "無法解析JSON. 原始結果", "Model Schema": "模型架構", "Model": "模型", "apply": "應用", "Username": "用戶名", "Password": "密碼", "Terms of service": "服務條款", "Created by": "創建者", "See more at": "查看更多：", "Contact the developer": "聯系開發者", "api version": "api版本", "Response Content Type": "響應Content Type", "fetching resource": "正在獲取資源", "fetching resource list": "正在獲取資源列表", "Explore": "瀏覽", "Show Swagger Petstore Example Apis": "顯示 Swagger Petstore 示例 Apis", "Can't read from server. It may not have the appropriate access-control-origin settings.": "無法從服務器讀取。可能沒有正確設置access-control-origin。", "Please specify the protocol for": "請指定協議：", "Can't read swagger JSON from": "無法讀取swagger JSON於", "Finished Loading Resource Information. Rendering Swagger UI": "已加載資源信息。正在渲染Swagger UI", "Unable to read api": "無法讀取api", "from path": "從路徑", "Click to set as parameter value": "點擊設置參數", "server returned": "服務器返回" }, //定時執行轉換 _translator2Cn = function () { if ($("#resources_container .resource").length > 0) { _tryTranslate(); } if ($("#explore").text() == "Explore" && iexcute < 500) { iexcute++; setTimeout(_translator2Cn, 50); } }, //設置控制器注釋 _setControllerSummary = function () { $.ajax({ type: "get", async: true, url: $("#input_baseUrl").val(), dataType: "json", success: function (data) { var summaryDict = data.ControllerDesc; var id, controllerName, strSummary; $("#resources_container .resource").each(function (i, item) { id = $(item).attr("id"); if (id) { controllerName = id.substring(9); strSummary = summaryDict[controllerName]; if (strSummary) { $(item).children(".heading").children(".options").prepend('<li class="controller-summary" title="' + strSummary + '">' + strSummary + '</li>'); } } }); } }); }, //嘗試將英文轉換成中文 _tryTranslate = function () { $('[data-sw-translate]').each(function () { $(this).html(_getLangDesc($(this).html())); $(this).val(_getLangDesc($(this).val())); $(this).attr('title', _getLangDesc($(this).attr('title'))); }); }, _getLangDesc = function (word) { return _words[$.trim(word)] !== undefined ? _words[$.trim(word)] : word; }; return { Translator: function () { //可以重寫頁面title //document.title = "API描述文檔"; $('body').append('<style type="text/css">.controller-summary{color:#10a54a !important;word-break:keep-all;white-space:nowrap;overflow:hidden;text-overflow:ellipsis;max-width:250px;text-align:right;cursor:default;} </style>'); $("#logo").html("接口描述").attr("href", "/Home/Index"); //設置控制器描述 _setControllerSummary(); _translator2Cn(); } } })(); //執行轉換 SwaggerTranslator.Translator();
2.在swaggerconfig.cs里設置swaggger_lang.js的路徑。在下圖中添加如下代碼
c.InjectJavaScript(thisAssembly, "Swagger.UI.Api.Scripts.swaggerui.swagger_lang.js");
3.漢化工作就做完了，運行如下。
控制器描述
1.添加CachingSwaggerProvider.cs文件
using Swashbuckle.Swagger; using System; using System.Collections.Concurrent; using System.Collections.Generic; using System.IO; using System.Linq; using System.Web; using System.Xml; namespace Swagger.UI.Api { public class CachingSwaggerProvider : ISwaggerProvider { private static ConcurrentDictionary<string, SwaggerDocument> _cache = new ConcurrentDictionary<string, SwaggerDocument>(); private readonly ISwaggerProvider _swaggerProvider; public CachingSwaggerProvider(ISwaggerProvider swaggerProvider) { _swaggerProvider = swaggerProvider; } public SwaggerDocument GetSwagger(string rootUrl, string apiVersion) { var cacheKey = string.Format("{0}_{1}", rootUrl, apiVersion); SwaggerDocument srcDoc = null; //只讀取一次 if (!_cache.TryGetValue(cacheKey, out srcDoc)) { srcDoc = _swaggerProvider.GetSwagger(rootUrl, apiVersion); srcDoc.vendorExtensions = new Dictionary<string, object> { { "ControllerDesc", GetControllerDesc() } }; _cache.TryAdd(cacheKey, srcDoc); } return srcDoc; } /// <summary> /// 從API文檔中讀取控制器描述 /// </summary> /// <returns>所有控制器描述</returns> public static ConcurrentDictionary<string, string> GetControllerDesc() { string xmlpath = string.Format("{0}/bin/Swagger.UI.Api.XML", System.AppDomain.CurrentDomain.BaseDirectory); ConcurrentDictionary<string, string> controllerDescDict = new ConcurrentDictionary<string, string>(); if (File.Exists(xmlpath)) { XmlDocument xmldoc = new XmlDocument(); xmldoc.Load(xmlpath); string type = string.Empty, path = string.Empty, controllerName = string.Empty; string[] arrPath; int length = -1, cCount = "Controller".Length; XmlNode summaryNode = null; foreach (XmlNode node in xmldoc.SelectNodes("//member")) { type = node.Attributes["name"].Value; if (type.StartsWith("T:")) { //控制器 arrPath = type.Split('.'); length = arrPath.Length; controllerName = arrPath[length - 1]; if (controllerName.EndsWith("Controller")) { //獲取控制器注釋 summaryNode = node.SelectSingleNode("summary"); string key = controllerName.Remove(controllerName.Length - cCount, cCount); if (summaryNode != null && !string.IsNullOrEmpty(summaryNode.InnerText) && !controllerDescDict.ContainsKey(key)) { controllerDescDict.TryAdd(key, summaryNode.InnerText.Trim()); } } } } } return controllerDescDict; } } }
2.注意要將下圖中位置的路徑改成你自己項目路徑。
3.在swaggerconfig.cs里配置CachingSwaggerProvider 。
c.CustomProvider((defaultProvider) => new CachingSwaggerProvider(defaultProvider));
錯誤解決
一個controller中只能有一個HttpGet請求，多了就會報錯。建議減少重載方法，將其他Get方法分開，例如在其他方法上加[httppost]特性
如果在swagger.config中加上c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First())；也可以解決錯誤，但是會只顯示第一個get方法