• Visual Studio 2015
• Windows 7
• .Net Framework 4.6.2

若未使用 Application Insights，不勾選。

選擇 Web API，並使用 No Authentication (若未使用任何認證方式)

1. 透過 Nuget GUI 安裝

2. 透過 Package Manager Console 安裝，安裝指令：

Install-Package Swashbuckle

3. 安裝前後差異

• +Swashbuckle
• +Swashbuckle.Core
• +WebActivatorEx
• Newtonsoft.Json version="7.0.1"

預設設定

選擇XML文件產出路徑，這邊設定為「bin\WebApplicationSwagger.XML」

修改 Property 後，顯示已修改過

EnableSwagger，設定 XML 路徑

c.IncludeXmlComments(GetXmlCommentsPath());

正確路徑：

        private static string GetXmlCommentsPath()
        {
            return System.IO.Path.Combine(AppDomain.CurrentDomain.BaseDirectory, @"bin\WebApplicationSwagger.XML");
        }

網址為：https://localhost:{Port}/swagger

EnableSwaggerUi，設定自訂範本 index.html

首頁範本下載

正確路徑：

c.CustomAsset("index", typeof(SwaggerConfig).Assembly, "專案名稱.Content.index.html");

路徑錯誤，顯示找不到 Embedded Resource：

設定 Content/index.html Property 為 Embedded Resource

路徑設定正確

c.DocumentTitle("My Swagger UI");

c.DocExpansion(DocExpansion.List);

• ASP.NET WEB API 文件產生器(2) - SWAGGER
• Web API文件產生器-Swagger
• Swashbuckle - Seamlessly adds a swagger to WebApi projects
• API & SDK Design #4, API 上線前的準備 - Swagger + Azure API Apps