C#WebApi 接口增加备注和测试 默认api文档

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文件。
在结尾处增加一段代码:
@Html.DisplayForModel("TestClientDialogs")
@section Scripts {
    <linktype ="text/css" href="~/Areas/HelpPage/HelpPage.css" rel="stylesheet" />
    @Html.DisplayForModel("TestClientReferences")
}

 到此,注释和测试工具均已配置完成。运行测试下效果。

 OK!

原文地址:https://www.cnblogs.com/netlock/p/13237690.html