1. 在NuGet中安裝Swagger的插件

在菜單欄中：工具 => NuGet包管理器 => 管理解決方案的NuGet程序包 => 瀏覽中搜索Swagger

需要下載的插件

2. 生成注釋文檔

右鍵項目根目錄（這里是Demo），選擇屬性，在屬性面板中進行下面操作

生成注釋

3. 解決出現(xiàn)的問題

如果項目啟動不了了，不要驚慌，注釋掉/App_Start/SwaggerNet.cs文件中的這兩行即可。

解決問題

到這里在瀏覽器中輸入http://localhost:port/swagger可以看到它已經(jīng)顯示API了，但你寫的注釋還沒有顯示出來。還剩下面最后一步。

4. 在SwaggerConfig.cs中配置注釋文件的路徑

在類中加入如下代碼：

// Add by Jun
protected static string GetXmlCommentsPath()
{
    // 這里的路徑要修改為你生成的XML文件路徑，在`步驟2`中可以看到
    return System.String.Format(@"{0}\bin\Demo.XML", System.AppDomain.CurrentDomain.BaseDirectory);
}

 c.IncludeXmlComments(GetXmlCommentsPath());

配置Xml文件的路徑

自此就配置成功了！

5. 寫注釋

注釋的格式如下：

/// <summary>
/// Show your name
/// </summary>
/// <param name="name">your name</param>
/// <returns></returns>
[System.Web.Http.HttpPost]
[System.Web.Http.Route("getname")]
public string Show(string name)
{
    return $"I know your name is {name}";
}

在瀏覽器中打開localhost:port/swagger就能看到效果了：

生成的效果