Web 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 文档说明的前提是你的 写注释!!!!!

 
分类: WebApi
标签: WebApi

最新文章

  1. jQuery之元素操作及事件绑定
  2. hibernate cascade=CascadeType.All
  3. 深入浅出 nginx lua 为什么高性能
  4. 第二百五十九天 how can I 坚持
  5. SignalTap II逻辑分析仪的使用
  6. OpenVPN-ng,为移动续航的应用层隧道
  7. VS 2017 Git failed with a fatal error的解决办法
  8. 全文检索Lucene (1)
  9. nginx+uwsgi+django开发环境搭建
  10. 20190317 A
  11. vs code 配置 php xdebug
  12. jquery实现同时展示多个tab标签+左右箭头实现来回滚动(美化版增加删除按钮)
  13. tarjan 算法求强连通分量
  14. BZOJ1819 [JSOI]Word Query电子字典 Trie
  15. 一道简单的python面试题-购物车
  16. 转:【WebView的cookie机制 】轻松搞定WebView cookie同步问题
  17. 添加vscode自定义代码块
  18. iOS开发如何学习前端(1)
  19. 【Java集合的详细研究8】List,Set,Map用法以及区别
  20. python笔记24-unittest单元测试之mock.patch

热门文章

  1. Debian 7设备nginx周围环境、编译并安装和启动
  2. 泛泰A900 刷4.4中国民营TWRP2.7.1.1版本 支持自己主动识别移动版本号(世界上第一)
  3. 《STL源代码分析》---stl_heap.h读书笔记
  4. Log4net 日志
  5. Sicily 1299 Academy Awards (map + vector)集装箱
  6. interview(转)
  7. 查询oracle sql运行计划,一个非常重要的观点--dba_hist_sql_plan
  8. sqlplus登录问题
  9. Linux内核和根文件系统引导加载程序
  10. 采用RedisLive监控Redis服务