033-Swagger

swagger是一个api文档工具，定义在代码中，能更好的维护和使用。下面介绍在springboot中的使用。

新建一个项目，只需要一个web组件即可：

然后添加依赖：

然后在启动类中配置一个bean，并加上开启swagger的注解：

注意上面配置的信息，一会这些信息会出现在页面相应的位置，来判断这些信息在具体项目中的内容。

swagger的配置内容完成了，接下来写一个接口，首先在controller类上定义本组接口的内容：

然后定义一个普通的接口：

接下来在接口上方定义api文档：

可以看到注解中简单定义了api文档的描述和参数。

接下来启动项目，访问  /swagger-ui.html  可以进入api文档管理页面：

展开接口，可以看到接口具体的定义：

输入必要的参数，点击  Try it out！按钮，可以进行简单接口测试：

API详细说明：

@ApiImplicitParam说明：

Swagger注解：

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

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

@ApiParam：单个参数描述

@ApiModel：用对象来接收参数

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

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

@ApiResponses：HTTP响应整体描述

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

@ApiError ：发生错误返回的信息

@ApiImplicitParam：一个请求参数

@ApiImplicitParams：多个请求参数

代码地址： https://gitee.com/blueses/spring-boot-demo