天天看點

SwaggerUI ASP.Net WebAPI2

目前在用ASP.NET的 WebAPI2來做背景接口開發,在與前台做測試的時候,總是需要發送一個demo給他,但是這樣很麻煩的,他還有可能記不住。

然後就想到SwaggerUI 生成測試文檔。

話不多說,來看看它的具體用法吧!

第一步:

在VS2015(後者是你自己的工具裡)打開程式包管理控制台輸入:

等待安裝,完成後會發現,在App_Start檔案夾下會多出來一個配置檔案SwaggerConfig.cs

SwaggerUI ASP.Net WebAPI2

第二步:

打開這個檔案然後找到Register()方法裡的c.IncludeXmlComments(),增加一個參數,也就是說改成c.IncludeXmlComments(GetXmlCommentsPath(thisAssembly.GetName().Name));

然後在跟Register方法平級的地方增加一個方法

然後配置檔案到此結束,

第三步:

繼續做對于項目的配置

SwaggerUI ASP.Net WebAPI2

右鍵項目->屬性->生成->勾選(XML文檔檔案)->點選儲存檔案即可。

第四步:

輸入通路路徑

這裡邊關于主機和端口需要替換成寄幾的。

最後成果

SwaggerUI ASP.Net WebAPI2

這裡做個備注,發現每個請求後邊都會有注釋,而且點開以後也有注釋,這個就是你在你的接口中的注釋,它可以直接拿過來顯示的。

SwaggerUI ASP.Net WebAPI2

參考:http://www.cnblogs.com/fangwei0505/p/6398382.html

同時放上SpringMVC的Demo:http://blog.csdn.net/u011499992/article/details/53455144

額外備注:

就是如果指令行安裝錯了位置了,就應該執行解除安裝指令。

Uninstall-Package Swashbuckle

本文轉自帥氣的頭頭部落格51CTO部落格,原文連結http://blog.51cto.com/12902932/1927605如需轉載請自行聯系原作者

sshpp