zoukankan      html  css  js  c++  java
  • WebAPI——自动生成帮助文档

    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:XXXXXXXSampleDirection.cs    什么的
    说的很清楚,对,就是你没给 属性和类 加上注释,怎么办呢?一条一条加注释,显然不可能。

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

    在生成一下看看就OK了

     还有一点亲身体验需要告知:

    areas的命名空间一定要是位于当前API 项目的同一个命名空间下,当然一般不需要考虑这些,但是由于的项目是在已有的基础上修改的,就修改了命名空间的名称,但是开始没用到帮助文档,就没改Areas部分的命名空间,测试总是看不到帮助文档,说是依赖部分找不到或是名称已修改,后来才焕然大悟,终于看到帮助文档的界面。

    接下来就看看写注释有哪些技巧了,待续……

  • 相关阅读:
    ASP.Net 2.0窗体身份验证机制详解(FormsAuthentication) (转载)
    获取页面得所有控件
    标题: 如何断开与另一台机器的连接(更换用户名和口令)
    C#数据类型及范围
    常用数学符号读法大全
    理解偏序关系
    理解全序关系
    理解拟序关系
    《离散数学》双语专业词汇表 名词术语中英文索引
    ORL人脸库
  • 原文地址:https://www.cnblogs.com/webenh/p/6596084.html
Copyright © 2011-2022 走看看