目前在用ASP.NET的 WebAPI2來(lái)做后臺(tái)接口開發(fā),在與前臺(tái)做測(cè)試的時(shí)候,總是需要發(fā)送一個(gè)demo給他,但是這樣很麻煩的,他還有可能記不住。
成都創(chuàng)新互聯(lián)公司是一家專注于成都網(wǎng)站設(shè)計(jì)、網(wǎng)站制作與策劃設(shè)計(jì),四方臺(tái)網(wǎng)站建設(shè)哪家好?成都創(chuàng)新互聯(lián)公司做網(wǎng)站,專注于網(wǎng)站建設(shè)10余年,網(wǎng)設(shè)計(jì)領(lǐng)域的專業(yè)建站公司;建站業(yè)務(wù)涵蓋:四方臺(tái)等地區(qū)。四方臺(tái)做網(wǎng)站價(jià)格咨詢:13518219792然后就想到SwaggerUI 生成測(cè)試文檔。
話不多說,來(lái)看看它的具體用法吧!
第一步:
在VS2015(后者是你自己的工具里)打開程序包管理控制臺(tái)輸入:
Install-Package Swashbuckle
等待安裝,完成后會(huì)發(fā)現(xiàn),在App_Start文件夾下會(huì)多出來(lái)一個(gè)配置文件SwaggerConfig.cs
第二步:
打開這個(gè)文件然后找到Register()方法里的c.IncludeXmlComments(),增加一個(gè)參數(shù),也就是說改成c.IncludeXmlComments(GetXmlCommentsPath(thisAssembly.GetName().Name));
然后在跟Register方法平級(jí)的地方增加一個(gè)方法
protected static string GetXmlCommentsPath(string name) { return string.Format(@"{0}\bin\{1}.XML", AppDomain.CurrentDomain.BaseDirectory, name); }
然后配置文件到此結(jié)束,
第三步:
繼續(xù)做對(duì)于項(xiàng)目的配置
右鍵項(xiàng)目->屬性->生成->勾選(XML文檔文件)->點(diǎn)擊保存文件即可。
第四步:
輸入訪問路徑
http://localhost:15416/swagger/ui/index
這里邊關(guān)于主機(jī)和端口需要替換成寄幾的。
最后成果
這里做個(gè)備注,發(fā)現(xiàn)每個(gè)請(qǐng)求后邊都會(huì)有注釋,而且點(diǎn)開以后也有注釋,這個(gè)就是你在你的接口中的注釋,它可以直接拿過來(lái)顯示的。
/// <summary>/// 發(fā)送手機(jī)驗(yàn)證碼/// </summary>/// <param name="mobile">手機(jī)號(hào)</param>
參考:http://www.cnblogs.com/fangwei0505/p/6398382.html
同時(shí)放上SpringMVC的Demo:http://blog.csdn.net/u01149×××/article/details/53455144
額外備注:
就是如果命令行安裝錯(cuò)了位置了,就應(yīng)該執(zhí)行卸載命令。
Uninstall-Package Swashbuckle
另外有需要云服務(wù)器可以了解下創(chuàng)新互聯(lián)scvps.cn,海內(nèi)外云服務(wù)器15元起步,三天無(wú)理由+7*72小時(shí)售后在線,公司持有idc許可證,提供“云服務(wù)器、裸金屬服務(wù)器、高防服務(wù)器、香港服務(wù)器、美國(guó)服務(wù)器、虛擬主機(jī)、免備案服務(wù)器”等云主機(jī)租用服務(wù)以及企業(yè)上云的綜合解決方案,具有“安全穩(wěn)定、簡(jiǎn)單易用、服務(wù)可用性高、性價(jià)比高”等特點(diǎn)與優(yōu)勢(shì),專為企業(yè)上云打造定制,能夠滿足用戶豐富、多元化的應(yīng)用場(chǎng)景需求。
網(wǎng)頁(yè)題目:SwaggerUIASP.NetWebAPI2-創(chuàng)新互聯(lián)
網(wǎng)頁(yè)網(wǎng)址:http://chinadenli.net/article2/dhpoic.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供手機(jī)網(wǎng)站建設(shè)、網(wǎng)站制作、品牌網(wǎng)站制作、自適應(yīng)網(wǎng)站、網(wǎng)站內(nèi)鏈、網(wǎng)站設(shè)計(jì)
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請(qǐng)盡快告知,我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如需處理請(qǐng)聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時(shí)需注明來(lái)源: 創(chuàng)新互聯(lián)
猜你還喜歡下面的內(nèi)容