webAPI 加注释生成帮助文档和测试demo

Posted 2021-01-04 kqnll

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

1：配置 接口注释。

 

（1）配置生成xml的路径。我们在项目上面点右键→属性→生成标签页配置xml的路径。

（2）在xml的读取路径：在AreasHelpPageApp_StartHelpPageConfig.cs里面配置xml的读取路径。

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

 

到此运行，Api 接口注释已经可以展示。

 

2：配置接口调试程序。

（1）右键项目，找到NuGet管理，查找 “WebApiTestClient”并安装。

（2）修改生成的 AreasHelpPageViewsHelpApi.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!