C# Swagger 生成接口文檔

一直聽說Swagger是做Web API文檔的好工具，這次手里暫時沒什么事，類體驗下它的強大之處。下面是使用Swashbuckle.net 給asp.net web API添加文檔的簡要步驟。

參考地址：http://www.jianshu.com/p/3329b4126886

項目引入Swagger

Swashbuckle是Swagger在dotnet環境中的實現，在ASP.net項目中加入后即可支持Swagger/UI。5.X版本支持ASP.net, 6.X(beta)版本支持ASP.net Core. 目前項目使用ASP.net for IIS，所以使用了5.6的版本。 關於selfhost和Owin Swashbuckle 的readme有很清楚的描述，可以去查看源碼

使用nuget加入Swashbuckle的引用

 

安裝好以后，在App_Start目錄下，會有一個SwaggerConfig.cs文件，SwaggerConfig類通過[assembly: PreApplicationStartMethod(typeof(SwaggerConfig), "Register")]啟動時運行。

nuget添加完引用，無須任何配置，編譯后，訪問 http://localhost:52079/swagger（這里按照自己的項目啟動端口更改） 即可看到所有API的文檔說明。界面如圖所示：

 

SwaggerConfig簡單介紹

SwaggerConfig.cs文件會自動添加到項目的App_Start目錄下，代碼本身包含大量注釋掉的代碼，清除后，代碼如下：

 

相關工程需要生成XML文檔

 

在SwaggerConfig 的Register方法的EnableSwagger匿名函數中加上對應的XML文件，修改如下： 

public class SwaggerConfig
    {
        public static void Register()
        {
            var thisAssembly = typeof(SwaggerConfig).Assembly;
            //獲取項目文件路徑
            var baseDirectory = System.Web.HttpContext.Current.Server.MapPath("~/App_Data");
            var commentsFileName = Assembly.GetExecutingAssembly().GetName().Name + ".XML";
            var commentsFile = Path.Combine(baseDirectory, commentsFileName);

            GlobalConfiguration.Configuration
                .EnableSwagger(c =>
                    {
                        //用於啟用和設置Swagger的配置信息。
                        c.SingleApiVersion("v1", "APIUI");
                        //單個xml文件注釋讀取
                        c.IncludeXmlComments(commentsFile);
                        //多個xml文件注釋讀取 使用多個時注釋單個
                        //DirectoryInfo dirct = new DirectoryInfo(baseDirectory);
                        //foreach (var item in dirct.GetFiles())
                        //{
                        //    if (item.Name.Contains(".xml"))
                        //    {
                        //        var name = baseDirectory + @"\" + item.Name;
                        //        c.IncludeXmlComments(name);
                        //    }
                        //}
                    })
                .EnableSwaggerUi(c =>
                    {
                        //用於啟用UI界面。

                    });
        }
    }

 

上述代碼把api工程的XML注釋加入到Swagger中。一般我們會把viewmodel或者其他類型定義在不同的工程中，通過下面的代碼可以繼續加入其它xml注釋文件。(對應功能需要啟用XML文檔文件生成)

注：如果System.Web.HttpContext.Current.Server.MapPath獲取項目路徑報錯的話改用下面這句代碼

 var baseDirectory = string.Format("{0}App_Data", System.Web.HttpRuntime.AppDomainAppPath);

漢化 SwaggerUI 

新增js,內容如下

'use strict';  
  
/** 
 * Translator for documentation pages. 
 * 
 * To enable translation you should include one of language-files in your index.html 
 * after <script src='lang/translator.js' type='text/javascript'></script>. 
 * For example - <script src='lang/ru.js' type='text/javascript'></script> 
 * 
 * If you wish to translate some new texsts you should do two things: 
 * 1. Add a new phrase pair ("New Phrase": "New Translation") into your language file (for example lang/ru.js). It will be great if you add it in other language files too. 
 * 2. Mark that text it templates this way <anyHtmlTag data-sw-translate>New Phrase</anyHtmlTag> or <anyHtmlTag data-sw-translate value='New Phrase'/>. 
 * The main thing here is attribute data-sw-translate. Only inner html, title-attribute and value-attribute are going to translate. 
 * 
 */  
window.SwaggerTranslator = {  
    _words: [],  
  
    translate: function () {  
        var $this = this;  
        $('[data-sw-translate]').each(function () {  
            $(this).html($this._tryTranslate($(this).html()));  
            $(this).val($this._tryTranslate($(this).val()));  
            $(this).attr('title', $this._tryTranslate($(this).attr('title')));  
        });  
    },  
  
    _tryTranslate: function (word) {  
        return this._words[$.trim(word)] !== undefined ? this._words[$.trim(word)] : word;  
    },  
  
    learn: function (wordsMap) {  
        this._words = wordsMap;  
    }  
};  
  
  
/* jshint quotmark: double */  
window.SwaggerTranslator.learn({  
    "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": "從路徑",  
    "server returned": "服務器返回"  
});  
  
  
$(function () {  
    window.SwaggerTranslator.translate();  
});  

注：右鍵點擊該js文件修改屬性為嵌入的資源

修改 SwaggerConfig文件：修改如下

 public static void Register()
        {
            var thisAssembly = typeof(SwaggerConfig).Assembly;
            //獲取項目文件路徑
            var baseDirectory = AppDomain.CurrentDomain.BaseDirectory + @"\App_Data\";
            var commentsFileName = Assembly.GetExecutingAssembly().GetName().Name + ".XML";

            var commentsFile = Path.Combine(baseDirectory, commentsFileName);

            GlobalConfiguration.Configuration
                .EnableSwagger(c =>
                    {
                        //用於啟用和設置Swagger的配置信息。
                        c.SingleApiVersion("v1", "APIUI");
                        //獲取項目指定路徑下xml文件
                        c.IncludeXmlComments(commentsFile);
                    })
                .EnableSwaggerUi(c =>
                    {
                        //用於啟用UI界面上的東西。
                        //加載漢化的js文件，注意 swagger.js文件屬性必須設置為“嵌入的資源”。 APIUI.Scripts.swagger.js依次是：項目名稱->文件夾->js文件名 
                        c.InjectJavaScript(Assembly.GetExecutingAssembly(), "APIUI.Scripts.swagger.js");
                    });
        }

 效果如下：

 在API中顯示返回的實體類模型跟注釋

在方法上加入特性SwaggerResponse，這里的model是實體類

[SwaggerResponse(HttpStatusCode.OK, Type = typeof(Model))]

效果如下：