原文:webAPI 自动生成帮助文档

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

2014-08-22 10:50 4 4467 推荐指数:

查看详情

MVC WebAPI自动生成帮助文档(转)

注意点: 1.mvc的控制器必须继承于ApiController,否则看不到的 2. 简单查看xml,根据第二步即可生成xml,可视感比较低,但是内容全部有,不限定于Api 以下为转载正文 ...

Tue Nov 07 21:08:00 CST 2017 1 1681
ASP.NET WebAPI 自动生成帮助文档

当您创建一个Web API,建立了一个帮助页面非常有用。可以手动创建的所有文件,但最好是能够自动生成。 为了使这项工作更容易,ASP.NET Web API提供了自动生成帮助页面的模板,如下图 如何创建Help Page? 1、用VS2013创建的Web API 2项目会默认带有 ...

Wed May 04 00:29:00 CST 2016 0 5859
Web Api 自动生成帮助文档

新建Web Api项目之后,会在首页有API的导航菜单,点击即可看到API帮助文档,不过很遗憾,Description 是没有内容的。 怎么办呢? 第一步: 如果用VS2013 新建项目的(VS2012没试过),项目中会有 Areas/HelpPage 这样的目录,你没看错,文档就是这货生成 ...

Wed Sep 17 19:23:00 CST 2014 5 3631
WebAPI使用多个xml文件生成帮助文档

一、前言 上篇有提到在WebAPI项目内,通过在Nuget里安装(Microsoft.AspNet.WebApi.HelpPage)可以根据注释生成帮助文档,查看代码实现会发现是基于解析项目生成的xml文档来作为数据源从而展示出来的。在我们的项目帮助文档需要的类(特指定义的Request ...

Sat May 30 08:44:00 CST 2015 5 2039
(转)WebApi自动生成在线文档WebApiTestClient

  原文链接:http://www.cnblogs.com/landeanfen/p/5210356.html 前言:这两天在整WebApi的服务,由于调用方是Android客户端,Android开发人员也不懂C#语法,API里面的接口也不能直接给他们看,没办法,只有整个详细一点的文档 ...

Wed Mar 02 18:46:00 CST 2016 1 2870
 
粤ICP备18138465号  © 2018-2025 CODEPRJ.COM