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


    注意点:

    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

  • 相关阅读:
    又是一年毕业季——程序员的苦与乐
    你的团队需要一个正确的程序集(dll)管理姿势
    说一说Web开发中两种常用的分层架构及其对应的代码模型
    理解RESTful API
    一文回顾Redis五大对象(数据类型)
    Redis对象——有序集合(ZSet)
    Redis对象——集合(Set)
    Redis对象——列表(List)
    Redis对象——哈希(Hash)
    Redis数据结构——quicklist
  • 原文地址:https://www.cnblogs.com/xcsn/p/7798531.html
Copyright © 2020-2023  润新知