码迷,mamicode.com
首页 > Windows程序 > 详细

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

时间:2020-07-05 10:33:58      阅读:108      评论:0      收藏:0      [点我收藏+]

标签:读取   html   reference   star   文件   spl   data   ati   styles   

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!

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

标签:读取   html   reference   star   文件   spl   data   ati   styles   

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

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!