.net WebApi 文檔注釋

默認(rèn)情況下新建的Web Api 2項(xiàng)目,自帶的Help頁(yè)下會(huì)顯示Api的相關(guān)信息,但Description那一欄無(wú)法獲取到數(shù)據(jù),如下圖所示:

解決方式：1.先啟用輸出的XML文檔文件:

在web api 項(xiàng)目上右擊->屬性,在屬性頁(yè)"生成"標(biāo)簽下,勾選輸出下面的"XML 文檔文件",如下圖所示:


2.在項(xiàng)目里,打HelpPageConfig.cs,去掉SetDocumentationProvider方法,并把地址改成與1里的對(duì)應(yīng),如下圖所示:


3.在Api上添加注釋,如下圖所示:


再次運(yùn)行項(xiàng)目,打開(kāi)Api Help頁(yè)面,就可以看到效果了,如下圖所示:


最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書(shū)系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

推薦閱讀更多精彩內(nèi)容

  • Android 自定義View的各種姿勢(shì)1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 173,337評(píng)論 25贊 708
  • Spring Cloud為開(kāi)發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見(jiàn)模式的工具（例如配置管理，服務(wù)發(fā)現(xiàn)，斷路器，智...
    卡卡羅2017閱讀 134,947評(píng)論 18贊 139
  • Spring Boot 參考指南 介紹 轉(zhuǎn)載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 46,958評(píng)論 6贊 342
  • 微信小程序開(kāi)放注冊(cè)了，注冊(cè)地址：https://mp.weixin.qq.com/wxopen/waregiste...
    充電實(shí)踐閱讀 266評(píng)論 0贊 0
  • 日月當(dāng)空照 不知秋雨近 最是離別時(shí) 才知情更怯 口中無(wú)言語(yǔ) 心中永想念 夢(mèng)中悔當(dāng)初 錯(cuò)把情意過(guò) 愿你意志堅(jiān) 了卻心...
    樊勇明閱讀 85評(píng)論 0贊 0