swagger 基础用法全解析
Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。
maven依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.6.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.6.0</version>
</dependency>
其中版本号视具体而定。
创建swagger配置类
package com.swaggerTest;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
* Swagger2配置类
* 在与spring boot集成时，放在与Application.java同级的目录下。
* 通过@Configuration注解，让Spring来加载该类配置。
* 再通过@EnableSwagger2注解来启用Swagger2。
*/
@Configuration
@EnableSwagger2
public class Swagger2 {
/**
* 创建API应用
* apiInfo() 增加API相关信息
* 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
* 本例采用指定扫描的包路径来定义指定要建立API的目录。
*
* @return
*/
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.swaggerTest.controller"))
.paths(PathSelectors.any())
.build();
}
/**
* 创建该API的基本信息（这些基本信息会展现在文档页面中）
* 访问地址：http://项目实际地址/swagger-ui.html
* @return
*/
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Spring Boot中使用Swagger2构建RESTful APIs")
.description("Swagger构建演示")
.termsOfServiceUrl("")
.contact("sunf")
.version("1.0")
.build();
}
}
swagger的注解说明
Swagger使用的注解及其说明：
@Api：用在类上，说明该类的作用。
@ApiOperation：注解来给API增加方法说明。
@ApiImplicitParams : 用在方法上包含一组参数说明。
@ApiImplicitParam：用来注解来给方法入参增加说明。
@ApiResponses：用于表示一组响应
@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
code：数字，例如400
message：信息，例如"请求参数没填好"
response：抛出异常的类
@ApiModel：描述一个Model的信息（一般用在请求参数无法使用@ApiImplicitParam注解进行描述的时候）
@ApiModelProperty：描述一个model的属性
其中每个注解的具体作用以及属性还可以通过查看源码的注释。
swagger 注解的使用
1. 整个类的说明
使用@Api,参考如下：
@Api(value = "ApiObjMapController, api配置映射对象信息控制类")
@Controller
@RequestMapping("/api/v1.0.0/apiObjMap")
public class ApiObjMapController {
}
2. 单个参数
方法使用@ApiOperation注解，单个参数直接使用@ApiImplicitParam，参考如下：
@ApiOperation(value = "根据id删除api配置映射对象", notes = "id必传。")
@ApiImplicitParam(paramType = "query", name = "id", value = "主键id", required = true, dataType = "String")
@RequestMapping(value = "/deleteApiObjMap", method = RequestMethod.GET)
@ResponseBody
public R deleteApiObjMap(@RequestParam("id") String id) {
}
3. 多个传参
多个参数可以使用使用@ApiImplicitParams搭配@ApiImplicitParam使用，示例如下：
@ApiOperation("api配置映射对象分页查询接口")
@ApiImplicitParams({
@ApiImplicitParam(paramType = "query", name = "pageNumber", value = "页码", defaultValue = "1", required = true, dataType = "int"),
@ApiImplicitParam(paramType = "query", name = "pageSize", value = "每页个数", defaultValue = "10", required = true, dataType = "int"),
@ApiImplicitParam(paramType = "query", name = "dsName", value = "数据源名称", dataType = "String"),
@ApiImplicitParam(paramType = "query", name = "collectType", value = "采集类型", dataType = "String")
})
@RequestMapping(value = "/getPageInfo", method = RequestMethod.GET)
@ResponseBody
public R getPageInfo(@RequestParam(value = "pageNumber", defaultValue = "1") int pageNumber,
@RequestParam(value = "pageSize", defaultValue = "10") int pageSize,
@RequestParam(value = "dsName", required = false) String dsName,
@RequestParam(value = "collectType", required = false) String collectType) {
}
4. 当传入参数是对象的时候
controller层代码如下：
@ApiOperation("保存api配置映射对象")
@RequestMapping(value = "/updateApiObjMap", method = RequestMethod.POST)
@ResponseBody
public R updateApiObjMap(@RequestBody @Valid ApiObjMap apiObjMap) {
}
直接在传入的对象对应的类代码上面使用@ApiModel （模型）和 @ApiModelProperty（具体属性），示例如下：
@ApiModel(value = "api对象映射配置类")
public class ApiObjMap {
@ApiModelProperty(value = "主键")
private String apiObjMapId;
@ApiModelProperty(value = "数据源名称", required = true)
@NotBlank(message = "数据源名称不能为空！")
private String dsName;
@ApiModelProperty(value = "采集类型", required = true)
@NotBlank(message = "采集类型不能为空！")
private String collectType;
@ApiModelProperty(value = "我们的字段名称", required = true)
@NotEmpty
private String ourCol;
@ApiModelProperty(value = "api的字段名称", required = true)
@NotEmpty
private String apiCol;
@ApiModelProperty(value = "指定值")
private String specificVal;
@ApiModelProperty(value = "对应含义")
private String meaning;
@ApiModelProperty(value = "数据类型", required = true)
@NotEmpty
private String dataType;
@ApiModelProperty(value = "创建时间", hidden = true)
private Date createTime;
@ApiModelProperty(value = "更新时间", hidden = true)
private Date updateTime;
// 省略get和set方法
}
对于用到@ApiModelProperty具体属性的说明：
- value： 属性含义说明
- required： 是否为必须参数
- hidden： 是否隐藏，如果
true的话，前端显示该类的时候会隐藏该字段。
这几个基本也是最常用的几个了。
5. 当传参对象为List嵌套对象时
controller层代码如下：
@ApiOperation("保存api配置映射对象list")
@RequestMapping(value = "/saveList", method = RequestMethod.POST)
@ResponseBody
public R saveList(@RequestBody @Valid ApiObjMapList list) {
}
直接在ApiObjMapList使用相关注解，并且嵌套对象ApiObjMap也使用了swagger的文档说明，具体内容同上面第4点。
@ApiModel(value = "api对象映射配置list模型")
@Data
public class ApiObjMapList {
@ApiModelProperty(value = "api对象映射配置列表", dataType = "list")
@Valid
List<ApiObjMap> list;
}
其中@ApiModelProperty还使用了属性dataType = "list"，说明类型为列表。这样就可以嵌套展示对象具体内容了，对于多个类嵌套的情况，这种方式应该都可用（小编目前没试过多个层层嵌套的）。
swagger前端
前端地址：
访问该地址即可查看你自己定义的接口文档信息了，并且可以直接调用接口，还是很方便的。
附录
整个结构以及大部分内容都是参考博客，下面会给出链接，还是很推荐的，但是代码部分是根据小编的实际编写来解释的。以及把日常会用到的情况都做了说明并给出例子。
参考：