使用ASP.NET Web API Help Pages 创建在线接口文档

时间:2023-03-09 16:11:52
使用ASP.NET Web API Help Pages 创建在线接口文档

操作步骤

1.新建Web API项目

使用ASP.NET Web API Help Pages 创建在线接口文档

2.在项目Areas文件夹下找到以下文件,取消注释图中代码。

使用ASP.NET Web API Help Pages 创建在线接口文档

3.右键解决方案,属性,如图设置。

使用ASP.NET Web API Help Pages 创建在线接口文档

4.运行程序,点击右上角API

使用ASP.NET Web API Help Pages 创建在线接口文档

接口列表:

使用ASP.NET Web API Help Pages 创建在线接口文档

详情-无参数:

使用ASP.NET Web API Help Pages 创建在线接口文档

详情-有参数:

使用ASP.NET Web API Help Pages 创建在线接口文档

这样,一个简单的API文档就形成了。

要是可以在线调试就好了!这么正常的需求肯定有人实现:Adding a simple Test Client to ASP.NET Web API Help Page

这个我还没try,不过应该没什么问题。

写在后面

1.当我完成前3步,运行程序,点击“API”时候报错,提示System.Web.Http.Description未引用,但是理论来说明明对的。

后面找到答案:修改System.Web.Http程序集属性:复制到本地:是。

答案链接:System.Web.Http.Description is missing from Add Reference List

*又help我一次。

2.参考文章:Creating Help Pages for ASP.NET Web API