zoukankan      html  css  js  c++  java
  • 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 文档说明的前提是你的 写注释!!!!!

    --------------------------------------------------------------------华丽丽的分割线---------------------------------------------------------------------------------------------------------

    Update :

    这样之后,你生成项目一看,几百个警告:警告    2    缺少对公共可见类型或成员“XXX.XXXXX.XXX”的 XML 注释    D:\XXXX\XXX\SampleDirection.cs    什么的
    说的很清楚,对,就是你没给 属性和类 加上注释,怎么办呢?一条一条加注释,显然不可能。

    于是,选中项目,右键属性,禁止显示警告输入:1591,如图:

    在生成一下看看就OK了

     

  • 相关阅读:
    Confluence 6 在升级过程中查看合并日志
    Confluence 6 从 WIKI 标记整合到基于 XHTML 的存储格式
    Confluence 6 升级完成后的检查
    Confluence 6 超过当前许可证期限进行升级
    HDU2571--命运---DP
    HDU 2084 DP经典例子---数塔问题
    紫书第二章
    求组合数
    欧拉函数
    二分幂/快速幂
  • 原文地址:https://www.cnblogs.com/softmax/p/3976724.html
Copyright © 2011-2022 走看看