Swagger整合Spring Boot

Swagger的作用

• 避免手动写api文档
• 接口返回结果确定
• 可以直接在线测试
• 便于管理
• 但是代码移入性强

使用步骤

1. 导入依赖

	<dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.6.1</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.6.1</version>
    </dependency>

2. 编写Swagger配置类

@Configuration
public class SwaggerConfig {

    @Bean
    public Docket api(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo()).select()
                // 自定修改为自己的包路径
                .apis(RequestHandlerSelectors.basePackage("com.xiamen.user.controller"))
                .paths(PathSelectors.any()).build();
    }

    @Bean
    public ApiInfo apiInfo(){
        return new ApiInfoBuilder().title("swagger文档标题").description("swagger接入文档副标题")
                // 服务条款网址
                .termsOfServiceUrl("https://www.baidu.com")
                .version("1.0")
                // 为contact()方法传入联系人对象
                .contact(new Contact("张三" , "www.baidu.cn" , "zhangsan@qq.com")).build();
    }
}

3. 为控制层方法添加描述性信息

@RestController
@RequestMapping("/login")
@Api("Login相关api")
public class Login {

    @ApiOperation(value = "根据姓名年龄查询" , notes = "查询数据库中的某些用户信息")
    @GetMapping("/login")
    public User login(User user){
        return user;
    }
}

4. 为实体类属性添加描述性信息

public class User implements Serializable {
	
    @ApiModelProperty(name = "id" , value = "用户ID" , required = true)
    private Integer id;

    @ApiModelProperty(name = "name" , value = "用户姓名" , required = true)
    private String name;

    @ApiModelProperty(name = "age" , value = "用户年龄" , required = true)
    private Integer age;
}

5. 在启动类上加 @EnableSwagger2 注解、启动

@SpringBootApplication
@MapperScan("com.xiamen.user.mapper")
@EnableSwagger2
public class ApplicationRun {
    public static void main(String[] args) {
        SpringApplication.run(ApplicationRun.class, args);
    }
}

6. 启动成功访问：http://localhost:8081/swagger-ui.html

Swagger注解

• @Api：用在请求的类上，表示对类的说明
  • tags “说明该类的作用，可以在UI界面上看到的注解”
  • value “该参数没什么意义，在UI界面上也看到，所以不需要配置”
    
    
• @ApiOperation：用在请求的方法上，说明方法的用途、作用
  • value=“说明方法的用途、作用”
  • notes=“方法的备注说明”
    
    
• @ApiImplicitParams：用在请求的方法上，表示一组参数说明.
  
  
• @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面.
  • 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：主要有两种用途：
  • 用于响应类上，表示一个返回响应数据的信息
  • 入参实体：使用@RequestBody这样的场景， 请求参数无法使用@ApiImplicitParam注解进行描述的时候
    
    
• @ApiModelProperty：用在属性上，描述响应类的属性
  
  
• @ApiOperation：用在请求的方法上，说明方法的用途、作用
  • value=“说明方法的用途、作用”
  • notes=“方法的备注说明”
    
    
• @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：用于响应类上，表示一个返回响应数据的信息
  • (这种一般用在post创建的时候，使用@RequestBody这样的场景, 请求参数无法使用@ApiImplicitParam注解进行描述的时候）
    
    
• @ApiModelProperty：用在属性上，描述响应类的属性
  • name：参数名
  • value：参数的汉字说明、解释
  • required：参数是否必须传
  • dataType：参数类型，默认String，其它值dataType=“Integer”