webapi行程开发文档

Posted 今晚再打老虎

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了webapi行程开发文档相关的知识,希望对你有一定的参考价值。

1.新建webapi项目

2.项目中controllers 中有一个values的为webapi接口

3.areas中域中有helppage为生成文档可以直接运行localhost/help,就会生成接口文档,描述就是程序中的注释

5.如果描述不显示需要更改一下项目属性

6.修改Areas\\HelpPage\\App_Start\\HelpPageConfig.cs中register方法里指定的xml路径为上述指定输出的路径

7.修改完后,controllers 会报缺少对可见公共类型或成员

8.如果需要测试的话,需要安装 WebApiTestClient 安装完成后,运行就可以

 

以上是关于webapi行程开发文档的主要内容,如果未能解决你的问题,请参考以下文章

webapi文档描述-swagger

webapi文档描述-swagger

WebAPI接口开发实践

Node交互式命令行工具开发——自动化文档工具

WebApi 文档Swagger

[Asp.Net Core]ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了