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了

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

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

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

转载于:https://www.cnblogs.com/webenh/p/6596084.html

WebAPI——自动生成帮助文档相关推荐

windows api中文文档_Web服务开发：Spring集成Swagger，3步自动生成API文档
目录: 1,Spring Boot集成Swagger 2,Swagger接口文档页面 3,常见问题和解决方法在Sping开发REST接口服务时,API文档是不可缺少的一个重要部分.Swagger框架 ...
springboot 集成 swagger 自动生成API文档
Swagger是一个规范和完整的框架,用于生成.描述.调用和可视化RESTful风格的Web服务.简单来说,Swagger是一个功能强大的接口管理工具,并且提供了多种编程语言的前后端分离解决方案. S ...
Django框架深入了解_05 (Django中的缓存、Django解决跨域流程(非简单请求，简单请求)、自动生成接口文档)(二)
二.跨域: 回到顶部跨域知识介绍: 点我以前博客跨域解决方法:CORS:跨域资源共享 CORS请求分类(简单请求和非简单请求) 简单请求(simple request):只需要在头信息之中增加一个 ...
Django框架深入了解_05 (Django中的缓存、Django解决跨域流程(非简单请求，简单请求)、自动生成接口文档)(一)
阅读目录一.Django中的缓存: 前戏: Django中的几种缓存方式: Django中的缓存应用: 二.跨域: 跨域知识介绍: CORS请求分类(简单请求和非简单请求) 示例: 三.自动生成接口 ...
swagger 修改dto注解_Web服务开发：Spring集成Swagger，3步自动生成API文档
目录: 1,Spring Boot集成Swagger 2,Swagger接口文档页面 3,常见问题和解决方法在Sping开发REST接口服务时,API文档是不可缺少的一个重要部分.Swagger框架 ...
【接口文档】Django restful framework中自动生成API文档
Django restful framework中自动生成API文档一.Swagger概述 1.引言当接口开发完成,紧接着需要编写接口文档.传统的接口文档使用Word编写,or一些接口文档管理平台 ...
Spring Boot（九）Swagger2自动生成接口文档和Mock模拟数据
一.简介在当下这个前后端分离的技术趋势下,前端工程师过度依赖后端工程师的接口和数据,给开发带来了两大问题: 问题一.后端接口查看难:要怎么调用?参数怎么传递?有几个参数?参数都代表什么含义? 问题二 ...
idea swagger生成接口文档_Spring Boot（九）Swagger2自动生成接口文档和Mock模拟数据...
一.简介在当下这个前后端分离的技术趋势下,前端工程师过度依赖后端工程师的接口和数据,给开发带来了两大问题: 问题一.后端接口查看难:要怎么调用?参数怎么传递?有几个参数?参数都代表什么含义? 问题二 ...
swagger php修改成中文,PHP使用swagger自动生成API文档
使用 swagger 自动生成 API 文档使用 swagger 自动生成 API 文档,有需要的朋友可以参考下. 一.下载 swagger-ui 直接上传服务器二.下载 swagger-php ...

WebAPI——自动生成帮助文档

Web Api 自动生成帮助文档

WebAPI——自动生成帮助文档相关推荐

最新文章

热门文章