WebAPI HelpPage是个插件,根据代码的注释生成API说明页,一目了然. 下面开始安装和配置 1.添加引用 先选择管理NuGet程序包,搜索 Microsoft.AspNet.WebApi.HelpPage 然后当然是安装啦~~~ 安装完成后我们看项目下是不是多出了一个文件夹Areas ,就是它 2.添加扩展 到了这步,我们先了解下App_Start 下的 HelpPageConfig.cs  ,打开后一堆注释,一个Register方法,它用来注册HelpPage页面需要展示的API的…

1.创建解决方案 2.选择类型-Web API 3.设置项目生成XML路径 同时修改HelpPageConfig,代码调用XML文件位置 3.编写WebApi接口代码 4.启动项目 查看接口 5.测试接口(添加WebApiTestClient组件) 安装完成之后,修改Api.cshtml文件 这个时候再运行项目就会发现API接口详情右下角有一个TESTAPI按钮,点击传参即可测试 测试接口 最后,至于接口描述注释等,我就不一一截图了,在编写接口是写好注释,页面会自动展示…

转自:http://edi.wang/post/2013/10/28/auto-generate-help-document-aspnet-webapi 我选择Web API的一个重要原因就是因为可以自动生成文档,省去了开发人猿不少宝贵的时间.以前在用Web API第一代的时候,自动生成帮助文档的功能默认是不完整的,现在到了Web API 2,这个功能已经通过NuGet包的形式很好的整合到了一起.我们来看一下吧! 首先,用VS2013创建的Web API 2项目会默认带有Microsoft AS…

WebAPI原生的HelpPage文档并不支持Area的生成,需进行如下改造: WebApiConfig: public static class WebApiConfig { public static void Register(HttpConfiguration config) { // Web API 配置和服务 // Web API 路由 config.MapHttpAttributeRoutes(); config.Routes.MapHttpRoute( name: "Defaul…

1.使用场景 默认创建的.Net Core WebAPI应用在运行时是没有页面显示的,效果如下: 那么,如果想要给API设置一个主页,应该怎么做呢?这就需要用到本文提供的方法. 2.设置方法 (1)首先,在项目Startup.cs文件中,设置Configure类的内容: 核心代码为: DefaultFilesOptions defaultFilesOptions = new DefaultFilesOptions(); defaultFilesOptions.DefaultFileNames.C…

引言 前边两篇博客介绍了Web API的基本框架以及路由配置,这篇博客主要解决在前后端分离项目中,为前端人员提供详细接口说明的问题,主要是通过修改WebApi HelpPage相关代码和添加WebApiTestClient组件实现WebAPI接口详细说明以及接口测试. WepAPI系列博客 ASP.NET Web API 2系列(一):初识Web API及手动搭建基本框架 ASP.NET Web API 2系列(二):灵活多样的路由配置 WebApi HelpPage帮助页 通过VS2017创建…

一.自动创建带帮助的WebAPI 1.首先创建项目的时候选择WebAPI,如下图所示,生成的项目会自动生成帮助文档. 2.设置调用XML文档的代码 3.设置项目注释XML文档生成目录,项目——属性——生成——勾选生成XML文档——设置目录为App_Data 4.Values控制器中的代码 /// <summary> /// Values控制器 /// </summary> public class ValuesController : ApiController { /// <…

当你创建一个网络 API 时,它很有用来创建一个帮助页,以便其他开发人员将知道如何调用您的 API.您可以创建的所有文档手动,但它是自动生成尽可能多地更好. 为了简化这一任务,ASP.NET Web API 提供一个库自动生成帮助页在运行时. 1.创建 API 帮助页 安装ASP.NET和Web Tools 2012.2 Update.此更新集成到 Web API 项目模板的帮助页面. 接下来,创建一个新的 ASP.NET MVC 4 项目并选择 Web API 项目模板.项目模板创建名为Val…

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

一.创建一个空的WebApi站点 二.新增一个名为Test的API控制器,实现部分方法(方法和类要添加文档说明注释) 1. 添加一个用户数据模型UserInfo.cs,代码如下: /// <summary> /// 用户信息 /// </summary> public class UserInfo { /// <summary> /// 用户ID /// </summary> public int ID { get; set; } /// <summa…