以前做项目需要先写接口文档，然后编写代码，有需求改动，需要维护好接口文档，再改代码，跟着要改代码的注释，这样做是很规范的，但是太麻烦了。swagger通过注解注释生成API接口文档节省时间，更方便沟通和开发。
现在swagger的最新版本是 swagger 3（OAS 3），之前的swagger 没有 strater项目需要单独引入swagger和ui.下面是springBoot整合swagger 3的使用方法。
一、pom文件中引入Swagger3依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
二、Application上面加入@EnableOpenApi注解
@EnableOpenApi
@SpringBootApplication
@MapperScan(basePackages = {"cn.ruiyeclub.dao"})
public class Swagger3Application {
public static void main(String[] args) {
SpringApplication.run(Swagger3Application.class, args);
}
}
三、Swagger3Config的配置
@Configuration
public class Swagger3Config {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.OAS_30)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Swagger3接口文档")
.description("更多请咨询服务开发者Ray。")
.contact(new Contact("Ray。", "http://www.ruiyeclub.cn", "ruiyeclub@foxmail.com"))
.version("1.0")
.build();
}
}
四、Swagger注解的使用说明
@Api：用在请求的类上，表示对类的说明
tags="说明该类的作用，可以在UI界面上看到的注解"
value="该参数没什么意义，在UI界面上也看到，所以不需要配置"
@ApiOperation：用在请求的方法上，说明方法的用途、作用
value="说明方法的用途、作用"
notes="方法的备注说明"
@ApiParam：描述参数
value="参数说明"
required="boolean 是否必须"
@ApiImplicitParams：用在请求的方法上，表示一组参数说明
@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
name：参数名
value：参数的汉字说明、解释
required：参数是否必须传
paramType：参数放在哪个地方
· header --> 请求参数的获取：@RequestHeader
· query --> 请求参数的获取：@RequestParam
· path（用于restful接口）--> 请求参数的获取：@PathVariable
· body（不常用）
· form（不常用）
dataType：参数类型，默认String，其它值dataType="Integer"
defaultValue：参数的默认值
@ApiResponses：用在请求的方法上，表示一组响应
@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
code：数字，例如400
message：信息，例如"请求参数没填好"
response：抛出异常的类
@ApiModel：用于bean上，描述返回对象
@ApiModelProperty：用在属性上，描述类的属性
Controller层的写法案例：
@Api(tags="测试接口")
@RestController
@RequestMapping("test")
public class TestController {
@ApiOperation(value = "获取测试数据")
@GetMapping("getTest")
public Result<TestModel> getTest(
@RequestParam @ApiParam(value="id标识",required=true)String id
){
return null;
}
}
model写法案例：
@Data
@ApiModel(description="测试bean")
public class TestModel {
@ApiModelProperty("id标识")
private String id;
@ApiModelProperty("名称")
private String name;
}
五、Swagger界面效果
启动项目访问接口文档界面 http://localhost:8080/swagger-ui/index.html
