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

    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
  • 相关阅读:
    linux 进程间通信之pipe
    makefile详解
    makefile基础
    std::list 源代码解析
    各类编译器 allocator 底层
    oop &&GP 模板 ---> 特化和偏特化
    STL Allocator
    关联式容器
    vector::erase
    maven
  • 原文地址:https://www.cnblogs.com/Leo_wl/p/3976857.html
Copyright © 2011-2022 走看看