WebApi 接口增加備註和測試

1:配置 接口註釋。

(1)配置生成xml的路徑。我們在項目上面點右鍵→屬性→生成標籤頁配置xml的路徑。


(2)在xml的讀取路徑:在Areas\HelpPage\App_Start\HelpPageConfig.cs裏面配置xml的讀取路徑。

config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/OpenAPI.xml")));



到此運行,Api 接口註釋已經可以展示。

2:配置接口調試程序。
(1)右鍵項目,找到NuGet管理,查找 “WebApiTestClient”並安裝。

(2)修改生成的 Areas\HelpPage\Views\Help\Api.cshtml文件。

在結尾處增加一段代碼:
@Html.DisplayForModel("TestClientDialogs")
@section Scripts {
    <linktype ="text/css" href="~/Areas/HelpPage/HelpPage.css" rel="stylesheet" />
    @Html.DisplayForModel("TestClientReferences")
}



到此,註釋和測試工具均已配置完成。運行測試下效果。




OK!


發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章