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

简介: 注意点: 1.mvc的控制器必须继承于ApiController,否则看不到的 2. 简单查看xml,根据第二步即可生成xml,可视感比较低,但是内容全部有,不限定于Api   以下为转载正文 ======================================================================================== 新建Web Api项目之后,会在首页有API的导航菜单,点击即可看到API帮助文档,不过很遗憾,Description 是没有内容的。

注意点:

1.mvc的控制器必须继承于ApiController,否则看不到的

2. 简单查看xml,根据第二步即可生成xml,可视感比较低,但是内容全部有,不限定于Api

 

以下为转载正文

========================================================================================

新建Web Api项目之后,会在首页有API的导航菜单,点击即可看到API帮助文档,不过很遗憾,Description 是没有内容的。

怎么办呢?

第一步:

如果用VS2013 新建项目的(VS2012没试过),项目中会有 Areas/HelpPage 这样的目录,你没看错,文档就是这货生成的。

如果要是删除了或者,没有这个目录怎么办呢?没关系,你只需要使用NuGet添加  【Microsoft.AspNet.WebApi.HelpPage】这货,然后你就发现,你的项目自动添加了 Areas/HelpPage这一坨

 

第二步:

选中项目,右键,属性,生成,选择下面的XML 文档文件,目录自己填写,如下图:

 

第三步:

找到 Areas/HelpPage/App_Start  目录下的HelpPageConfig.cs 文件,Register 方法,添加一行代码:

1 config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/Areas/HelpPage/WebApiHelp.XML")));

然后生成一下,启动项目,点击API看看

 

然后你就会感觉,自己棒棒哒。。。

 

Ps: 生成API 文档说明的前提是你的 写注释!!!!!

 

 

来自

http://blog.csdn.net/shiyaru1314/article/details/49995547

相关文章推荐

http://www.cnblogs.com/pmars/p/3673654.html

 

相关文章
|
11月前
|
前端开发 网络协议 Java
02.【基础】sdk和runtime区别及让你一睹为快使用CLI在CentOS上快速搭建Console,WebApi,MVC三大应用模型
02.【基础】sdk和runtime区别及让你一睹为快使用CLI在CentOS上快速搭建Console,WebApi,MVC三大应用模型
179 0
|
JavaScript 前端开发 BI
mvc+js实现自动生成.doc文件
mvc+js实现自动生成.doc文件
110 0
mvc+js实现自动生成.doc文件
|
开发框架 JSON .NET
HttpClient 调用WebAPI时—传参的三种方式(ASP.NET MVC&CORE均适用)
HttpClient 调用WebAPI时—传参的三种方式(ASP.NET MVC&CORE均适用)
232 0
|
前端开发 .NET API
如何解决Asp.Net MVC和WebAPI的Controller名称不能相同的问题
原文:如何解决Asp.Net MVC和WebAPI的Controller名称不能相同的问题 1、问题描述 假如有一个文章的业务(Article),我们在 Controllers文件夹中创建MVC Controller和Api Controller,各个Controller中都有相同的获取文章内容的Action(Content)。
1436 0
|
JSON 前端开发 .NET
自行实现高性能MVC WebAPI
  wcf虽然功能多、扩展性强但是也面临配置忒多,而且restful的功能相当怪异,并且目前没法移植。asp.net core虽然支持webapi,但是功能也相对繁多、配置复杂。就没有一个能让码农们安安心心的写webapi,无需考虑性能、配置、甚至根据问题场景自行设计、改造等问题的方案么?   当然不是,特别是在dnc2.
1718 0