为了方面APP开发人员,服务端的接口都应当提供详尽的API说明.但每次有修改,既要维护代码,又要维护文档,一旦开发进度紧张,很容易导致代码与文档不一致. Web API有一个Help Page插件,可以很方便的根据代码及注释自动生成相关API说明页面. Help Page安装步骤及扩展(以VS2015为例): 右键点击WebAPI项目的引用,选择"管理NuGet程序包" 在搜索框中输入 helppage进行搜索,结果如下图: 然后在右侧边栏点击安装按钮即可进行插件安装了. 安装完成后,…

关于ASP.NET Web Api的HelpPage文档注释问题 以前我用微软的HelpPage来自动生成的webAPI帮助文档.在使用了一段时间后发现只能显示Controller上面写的注释文档内容.以前总以为是微软这个类库的bug.后来才明白了是由于我的设置不当. 微软的HelpPage类库 controller上的注释 AlarmRecodrdDto文档 我们可以很清楚的看到,返回的`AlarmRecodrdDto`并没有注释文档啊!可是我已经在类库的中写过了该代码的注释的.为毛就没有呢?…

继续使用记录的第二节,HelpPage的优化与测试工具WebApiTestClient的使用. 之前没怎么整理博客,都是记录一下笔记,真正好好整理发现没想像的那么简单.不管怎么说还是培养下写博客的习惯吧,不管写的好与不好,学习了总要分享一下才对,开干! 本节目录 HelpPage页面修改+自定义api列表 页面修改 显示备注与Model的描述信息 自定义api列表 测试工具WebApiTestClient的使用 安装与配置 固定header参数处理 正文开始! 一.HelpPage页面修改+自定…

前言 你需要为客户编写Api调用手册?你需要测试你的Api接口?你需要和前端进行接口对接?那么这篇文章应该可以帮到你.本文将介绍创建Web Api 帮助文档页面的两种方式,Microsoft Help Page和Swashbuckle Help Page. 编写RESTful的Web Api /// <summary> /// 股票数据接口 /// </summary> [RoutePrefix("api/stocks")] public class Stock…

asp.net web api 的版本 升级到 2.2的记录 asp.net web api 2.2相比1.0提升了不少 而且其中最重要的就是有了在线文档的自动字段注释的功能 再也不用写详细的字段说明文档了 本次跟新使用的是nuget来更新包引用的,不得不说有了nuget让项目应用的包管理变得非常方便了 1. 首先请确认你项目.net版本最低是4.5的 2. 更新 api 打开nuget管理 搜索 web api 找到 直接点更新 一些依赖的package也会自动更新 但是现在生成失败 因为现在…

对Web API新手来说,不要忽略了ApiController 在web API中,方法的返回值如果是实体的话实际上是自动返回JSON数据的例如: 他的返回值就是这样的: { "Content": true, , "RequestMessage": "sample string 2" } 这是定义的Response类 public class Response<T> //where T : class { public T Conte…

ASP.NET Web API路由,简单来说,就是把客户端请求映射到对应的Action上的过程.在"ASP.NET Web API实践系列03,路由模版, 路由惯例, 路由设置"一文中,体验了通过模版.惯例.HTTP方法来设置路由,这种做法的好处是把路由模版统一放在了App_Start文件夹下的WebApiConfig类中,方便管理,但缺点是不够灵活. REST把一切都看成资源,有时候,一个资源连带子资源,比如Customer和Orders密切关联,我们可能希望输入这样的请求:cust…

之前在项目中有用到webapi对外提供接口,发现在项目中有根据webapi的方法和注释自动生成帮助文档,还可以测试webapi方法,功能很是强大,现拿出来与大家分享一下. 先看一下生成的webapi文档. 1.下图展示的是生成帮助文档首页面,其中Values是controller,API下面的列表展示出请求的http方法(Get,POST等),请求的action,方法的描述. 2.点击红框内的链接,打开api方法的详情页面,如下图所示, 3.点击Test API打开如下页面 4.输入参数,点击S…

转载地址:http://www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages 当创建web API 时,经常要创建一个帮助页,以便其他开发人员知道如何调用您的 API.您可以手动创建的所有文档,但最好是尽可能多地自动生成. 为了简化这一任务,ASP.NET Web API 提供一个库自动生成帮助页. 创建 API 帮助页 安装ASP.NET 和 Web 工具 2012.2 的更新.此更新集成到 Web API…

asp.net web api 测试帮助页面建立并测试 现在使用WEB API来开发,越来越流行. 在开发过程中的测试调试,可以使用Fiddler等工具来帮助测试外,还有: 在asp.net 中有种方式可以建立一个帮助测试页面来帮助测试调试API接口,非常的方便. 英文原文地址: http://blogs.msdn.com/b/yaohuang1/archive/2012/12/02/adding-a-simple-test-client-to-asp-net-web-api-help-page…