开发者社区> 芝麻软件> 正文
阿里云
为了无法计算的价值
打开APP
阿里云APP内打开

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

 

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
Hsa-Mbs开发维护文档(下)
在分类目录下就可以添加相应的模块了,模块按复杂程度可分为单功能模块和多功能模块,不同类型模块目录结构有所不同。
129 0
再见 Swagger UI,国人开源了一款超好用的 API 文档生成框架,Star 4.7K+,真香……
最近,栈长发现某些国内的开源项目都使用到了 Knife4j 技术,看名字就觉得很锋利啊!
243 0
Java:一个API文档框架Swagger
Java:一个API文档框架Swagger
77 0
Spring3 MVC中使用Swagger生成API文档
Spring3 MVC中使用Swagger生成API文档 一:Swagger介绍 Swagger是当前最好用的Restful API文档生成的开源项目,通过swagger-spring项目 实现了与SpingMVC框架的无缝集成功能,方便生成spring restful风格的接口文档, 同时swagger-ui还可以测试spring restful风格的接口功能。
1589 0
推荐几款API文档集合工具
https://zealdocs.org/    开源、免费,支持Linux、Windows http://velocity.silverlakesoftware.com/  https://kapeli.com/dash
883 0
MVC4 WebAPI(一)
不管是因为什么原因,结果是在新出的MVC中,增加了WebAPI,用于提供REST风格的WebService,个人比较喜欢REST风格的WebService,感觉比SOAP要轻量级一些,而且对客户端的要求也更少,更符合网络数据传输的一般模式,客户端完全摆脱了代理和管道来直接和WebService进行交...
1118 0
Web系统下Office文档的处理
在web环境中,我们经常遇到需要对Office文档进行各种各样的处理,如:格式转化、统计、修改等各种操作,如果使用Office的客户端对象模型直接处理,一般会遇到:效率低;服务器资源负载大等一系列问题,毕竟Office对象实现时主要针对的是客户端的使用而设计的,对于批量和大负载的处理自然效率欠佳。
861 0
+关注
芝麻软件
编程语言,框架相关专家
文章
问答
文章排行榜
最热
最新
相关电子书
更多
Java Spring Boot开发实战系列课程【第7讲】:Spring Boot 2.0安全机制与MVC身份验证实战(Java面试题)
立即下载
蚂蚁金服大数据开放式创新实践
立即下载
低代码开发师(初级)实战教程
立即下载