告别手写时代:好用的API文档生成工具

每当我们接口写完了，就要着手准备写文档方便交接，如果你还通过手写的方式来生成和编写这些文档，那么你就OUT啦！话说工欲善其事必先利其器，本文分享非常好用的API文档生成工具给大家。

• Swagger简介：

Swagger旨在为REST APIs 定义一个标准。与语言无关的接口，使人和计算机在看不到源码或者看不到文档或者不能通过网络流量检测的情况下能发现和理解各种服务的功能。当服务通过Swagger定义，消费者便能与远程的服务互动通过少量的实现逻辑。

为了实现在线文档的生成，步骤如下：

1、jar包依赖

2、添加Swagger配置文件

3、Spring mvc中配置

在自动扫描目录中加入 springfox：

静态资源列表中加入：

4、Controller 方法中加入swargger注解：

通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息的等等。

@Api：修饰整个类，描述Controller的作用

@ApiOperation：描述一个类的一个方法，或者说一个接口

@ApiParam：单个参数描述

@ApiModel：用对象来接收参数

@ApiModelProperty：用对象接收参数时，描述对象的一个字段

@ApiResponse：HTTP响应其中1个描述

@ApiResponses：HTTP响应整体描述

@ApiIgnore：使用该注解忽略这个API

@ApiImplicitParam：一个请求参数

@ApiImplicitParams：多个请求参数

对象中添加swargger注解

5、启动项目

通过连接访问api文档：

对编程感兴趣，想了解更多的编程知识，关注头条号一起玩转编程

更多编程资讯、干货持续更新中~