目前在用ASP.NET的 WebAPI2來做后台接口開發,在與前台做測試的時候,總是需要發送一個demo給他,但是這樣很麻煩的,他還有可能記不住。
然后就想到SwaggerUI 生成測試文檔。
話不多說,來看看它的具體用法吧!
第一步:
在VS2015(后者是你自己的工具里)打開程序包管理控制台輸入:
Install-Package Swashbuckle
等待安裝,完成后會發現,在App_Start文件夾下會多出來一個配置文件SwaggerConfig.cs
第二步:
打開這個文件然后找到Register()方法里的c.IncludeXmlComments(),增加一個參數,也就是說改成c.IncludeXmlComments(GetXmlCommentsPath(thisAssembly.GetName().Name));
然后在跟Register方法平級的地方增加一個方法
protected static string GetXmlCommentsPath(string name) { return string.Format(@"{0}\bin\{1}.XML", AppDomain.CurrentDomain.BaseDirectory, name); }
然后配置文件到此結束,
第三步:
繼續做對於項目的配置
右鍵項目->屬性->生成->勾選(XML文檔文件)->點擊保存文件即可。
第四步:
輸入訪問路徑
http://localhost:15416/swagger/ui/index
這里邊關於主機和端口需要替換成寄幾的。
最后成果
這里做個備注,發現每個請求后邊都會有注釋,而且點開以后也有注釋,這個就是你在你的接口中的注釋,它可以直接拿過來顯示的。
/// <summary> /// 發送手機驗證碼 /// </summary> /// <param name="mobile">手機號</param>
參考:http://www.cnblogs.com/fangwei0505/p/6398382.html
同時放上SpringMVC的Demo:http://blog.csdn.net/u011499992/article/details/53455144
額外備注:
就是如果命令行安裝錯了位置了,就應該執行卸載命令。
Uninstall-Package Swashbuckle