1. 程式人生 > >webAPI 加註釋生成幫助文檔和測試demo

webAPI 加註釋生成幫助文檔和測試demo

class pat doc water onf provide code pen center

轉自https://blog.csdn.net/a123_z/article/details/71078062

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文件。

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

技術分享圖片 到此,註釋和測試工具均已配置完成。運行測試下效果。 技術分享圖片 技術分享圖片 技術分享圖片 OK!

webAPI 加註釋生成幫助文檔和測試demo