環境:vs2013+web api 2
問題:默認情況下新建的Web Api 2項目,自帶的Help頁下會顯示Api的相關信息,但Description那一欄無法獲取到數據,如下圖所示:
解決:
1.先啟用輸出的XML文檔文件:
在web api項目上右擊->屬性,在屬性頁"生成"標簽下,勾選輸出下面的"XML 文檔文件",如下圖所示:
2.在"解決方案管理器"里,打HelpPageConfig.cs,去掉SetDocumentationProvider方法,並把地址改成與1里的對應,如下圖所示:
3.在Api上添加注釋,如下圖所示:
再次運行項目,打開Api Help頁面,就可以看到效果了,如下圖所示:
參考:ASP.NET Web API Help Page documentation using Xml comments on controllers