ASP.NET Web API 使用Swagger生成在線幫助測試文檔

時間 2019-11-29

標籤 asp.net asp web api 使用 swagger 生成在線幫助測試文檔欄目 ASP 简体版

原文原文鏈接

Swagger-UI簡單而一目瞭然。它可以純碎的基於html+javascript實現，只要稍微整合一下便能成爲方便的API在線測試工具。項目的設計架構中一直提倡使用TDD（測試驅動）原則來開發，swagger-ui在這方面更是能提供很大幫助。

Swagger-UI更傾向於在線測試接口和數據，但其核心是一個javascript插件，只要稍做修改，便能按需求定製出不一樣格式的說明文檔，在github上更是基於它集成到各類語言環境，分支衆多。

其官方提供了一個離線版本，它的使用方法十分簡單：直接在js格式的資源文件中錄入REST API的json信息，便能容易地生成不一樣模塊下的API列表，每一個API接口描述和參數、請求方法都能在每一個json數組中定製。下面是目前項目中使用到的部分預覽圖： javascript

在.net中使用html

1.NuGet包安裝java

Install-Package Swashbucklegit

2.安裝以後會在App_Start文件夾中添加SwaggerConfig.cs類，該類中的Register()方法會在應用程序啓動的時候調用github

3.啓用生成xml文檔，右擊項目文件屬性json

4.配置SwaggerConfig.cs數組

 public class SwaggerConfig
    {
        public static void Register()
        {
            Swashbuckle.Bootstrapper.Init(GlobalConfiguration.Configuration);
 
            // NOTE: If you want to customize the generated swagger or UI, use SwaggerSpecConfig and/or SwaggerUiConfig here ...
 
            SwaggerSpecConfig.Customize(c =>
            {
                c.IncludeXmlComments(GetXmlCommentsPath());
            });
        }
 
        protected static string GetXmlCommentsPath()
        {
            return System.String.Format(@"{0}\bin\WebApiSwagger.XML", System.AppDomain.CurrentDomain.BaseDirectory);
        }
    }