HelpPage

http://www.cnblogs.com/pmars/p/3673654.html 如何给你的ASP.NET页面添加HelpPage

WebApi_HelpPage http://www.cnblogs.com/gossip/p/4546630.html

WebAPI使用多个xml文件生成帮助文档(转)

Web API 版本控制的几种方式 http://blog.csdn.net/hengyunabc/article/details/20506345

http://stackoverflow.com/questions/14830391/how-do-i-get-asp-net-web-api-working-with-versioning-and-the-help-page-extension

http://stackoverflow.com/questions/28730307/web-api-routing-and-a-web-api-help-page-how-to-avoid-repeated-entries

http://stackoverflow.com/questions/389169/best-practices-for-api-versioning/398564#398564

http://www.troyhunt.com/2014/02/your-api-versioning-is-wrong-which-is.html

http://www.lexicalscope.com/blog/2012/03/12/how-are-rest-apis-versioned/

http://blogs.msdn.com/b/yaohuang1/archive/2012/08/15/introducing-the-asp-net-web-api-help-page-preview.aspx

http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/creating-api-help-pages

时间: 2025-01-17 15:52:37

HelpPage的相关文章

weiapi2.2 HelpPage自动生成接口说明文档和接口测试功能

在开发Webapi项目时每写完一个方法时,是不是需要添加相应的功能说明和测试案例呢?为了更简单方便的写说明接口文档和接口测试HelpPage提供了一个方便的途径. 她的大致原理是:在编译时会生成.dll程序集和.xml程序集说明文件,通过xml文件获取Controller名称.action名称.参数信息和备注信息等.这样接口说明文档就可以放到备注信息了,个人觉得确实粗暴简单 .那接口测试在哪呢?这里用到nuget第三方程序包:webapitestclient 先上效果图吧! 案例是用VS2013

WebAPI HelpPage支持area

开篇:对于WebApi研究不是很深,刚开始使用,记录自己的解决思路,有更好的处理方式或发现我对WebApi理解有不对的地方恳请指正,谢谢! 环境:WebAPI服务.HelpPage,API路由:"api/{controller}/{action}",服务与helpPage运行正常,帮助文档页面所有API地址遵循路由格式 问题描述:当两个area下出现同名的controller/action时,生成的帮助文档页面API地址会一模一样,请求出错 解决思路:将路由定义为"api/{

如何在Web项目中给没有添加API核心组件添加APIController的帮助页HelpPage

前言: ASP.NET中的Web项目可以通过APIController控制器来为其他项目提供接口.  而我们在调试这些接口时,可以选择单元测试,网页测试(Get接口),自己写测试代码或者第三方测试工具等等(如:PostMan可以发送GET/POST请求). 但这里为大家介绍一种新的调试工具:微软提供的一种关于APIController控制器说明帮助页+测试(借助第三方)的方法来帮助开发.  废话不多说,请看原文: 以下文章转载自:http://www.cnblogs.com/pmars/p/36

visual studio 2015中的webapi生成helpPage,页面不显示方法说明问题解决

环境: vs2015.win7 参考:http://www.cnblogs.com/Erik_Xu/p/5638381.html 生成的help页面如下:,并没有显示控制器和方法. 原因是:新建项目时候没有勾选Web Api,webapi是后来添加的.缺少App_Start下的WebApiConfig.cs文件,如下.要显示Action,更改为 routeTemplate: "api/{controller}/{action}/{id}", public static class We

Web Api帮助页面或用户手册

我这么玩Web Api(一):帮助页面或用户手册(Microsoft and Swashbuckle Help Page) 前言 你需要为客户编写Api调用手册?你需要测试你的Api接口?你需要和前端进行接口对接?那么这篇文章应该可以帮到你.本文将介绍创建Web Api 帮助文档页面的两种方式,Microsoft Help Page和Swashbuckle Help Page. 编写RESTful的Web Api   Microsoft Help Page 1.在Nuget添加Help Page

asp.net web api帮助文档的说明

为asp.net的mvc web api填写自己的帮助文档 1. 加入Help的area(能够通过命令行或其它方式加入) 命令行:Install-Package Microsoft.AspNet.WebApi.HelpPage NuGet搜索:HelpPage,找到Microsoft asp.net web api help page 2. 为api等加入凝视 3. 生成凝视为xml文件 4. 将xml赋予Help的configuration 在help的config文件里 HelpPageCo

项目梳理6——使用WebApiTestClient为webapi添加测试

1.使用nuget添加WebApiTestClient的引用 2.xxxxx.WebApi\Areas\HelpPage\Views\Help\Api.cshtml页面末尾添加如下代码: 3.显示结果 此测试永远无法代替单元测试!!!,单元测试不可少

webapi文档描述-swagger

最近做的项目使用mvc+webapi,采取前后端分离的方式,后台提供API接口给前端开发人员.这个过程中遇到一个问题后台开发人员怎么提供接口说明文档给前端开发人员,最初打算使用word文档方式进行交流,实际操作中却很少动手去写.为了解决这个问题,特意在博客园中搜索了一下api接口文档生成的文章,引起我注意的有两种方案.1.微软自带的Microsoft.AspNet.WebApi.HelpPage  2.swagger(我比较喜欢戏称为“丝袜哥”) 最先尝试的是微软自带的方案,由于项目对webap

WebApiTestClient自定义返回值说明

WebApiTestClient是基于微软HelpPage一个客户端调试扩展工具,用来做接口调试比较方便.但是对返回值的自定义说明还是有缺陷的.有园友写过一篇文章,说可以通过对类进行注释,然后通过在IHttpActionResult上标记ResponseType(typeof(class))即可. [ResponseType(typeof(CreditRuleDetails))] public IHttpActionResult GetCreditRuleList(int ruleType =