1. 程式人生 > >Asp.Net Mvc WebApi整合Swagger

Asp.Net Mvc WebApi整合Swagger

看到好多都用Swagger生成API文件,但是在網上找了幾個blog根據寫了之後,發現一下坑,現記錄下來

1、新建一個專案,SwaggerMvc5Demo,如果選擇mvc專案,需要引用web API引用。或者直接選擇Web API專案。

2、新增對Swagger的引用:在nuget中搜索:Swashbuckel,現在的版本為5.6.0;進行安裝

3、點選專案->屬性->生成,在輸出欄中選擇:XML文件檔案,前面的複選框進行打勾。生成xml文件

4、配置SwaggerConfig.cs檔案

在EnableSwagger中找到註釋的內容:

註釋內容: 

//c.IncludeXmlComments(GetXmlCommentsPath());

 大約在104行,取消註釋,新增方法:GetXmlCommentsPath(),返回專案xml檔案所在路徑

protected static string GetXmlCommentsPath()
{
     return $"{System.AppDomain.CurrentDomain.BaseDirectory}\\bin\\SwaggerMvc5Demo.xml";
}

 5、在_Layout.cshtml中新增超連結到swagger

6、點選CTRL+F5,執行專案,點選Swagger Help,看到介面如下,有可能controller的方法時隱藏的,只需點選Show/Hide

進行顯示/隱藏操作即可