spring boot 整合swagger

1. 核心依赖

    io.springfox
    springfox-swagger2
    2.9.2


    io.springfox
    springfox-swagger-ui
    2.9.2

2.config包下SwaggerConfig

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .pathMapping("/")
                .select()
                .apis(RequestHandlerSelectors.basePackage("net.wanho.controller"))//controller所在包
                .paths(PathSelectors.any())
                .build().apiInfo(new ApiInfoBuilder()
                        .title("SpringBoot整合Swagger") //文档标题
                        .description("SpringBoot整合Mybatis的CRUD操作") //文档描述
                        .version("1.0") //文档版本
                        .build());
    }
}

3. 常用注解

• @Api：用在请求的类上，表示对类的说明

  tags="说明该类的作用，可以在UI界面上看到的注解"
  value="该参数没什么意义，在UI界面上也看到，所以不需要配置"

• @ApiOperation：用在请求的方法上，说明方法的用途、作用

  value="说明方法的用途、作用"
  notes="方法的备注说明"

• @ApiImplicitParams：用在请求的方法上，表示一组参数说明

  • @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面

    name：参数名
    value：参数的汉字说明、解释
    required：参数是否必须传
    paramType：参数放在哪个地方
    · header --> 请求参数的获取：@RequestHeader
    · query --> 请求参数的获取：@RequestParam
    · path（用于restful接口）--> 请求参数的获取：@PathVariable
    dataType：参数类型，默认String，其它值dataType="Integer"
    defaultValue：参数的默认值

    @ApiOperation("分页查询学生接口")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "pageNo", value = "页码", required = true),
            @ApiImplicitParam(name = "pageSize", value = "每页大小", required = true)
    })
    Result list(@PathVariable int pageNo, @PathVariable int pageSize);

• @ApiResponses：用在请求的方法上，表示一组响应

  @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
  code：数字，例如400
  message：信息，例如"请求参数没填好"
  response：抛出异常的类

• @ApiModel：用于响应类上，表示一个返回响应数据的信息

  （这种一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）

  • @ApiModelProperty：用在属性上，描述响应类的属性

@ApiOperation("新增学生接口")
Result addStudent(@RequestBody Student student);


@ApiOperation("根据id修改学生接口")
@ApiImplicitParam(name = "id", value = "学生ID", required = true)
Result updateStudent(@PathVariable int id, @RequestBody Student stu);

@Data
@AllArgsConstructor
@NoArgsConstructor
@ApiModel
public class Student {
    @ApiModelProperty("学生ID")
    private Integer stuId;
    @ApiModelProperty("学生姓名")
    private String stuName;
    @ApiModelProperty("性别")
    private Character gender;
    @DateTimeFormat(pattern = "yyyy-MM-dd") //输入 String->Date
    @JsonFormat(pattern = "yyyy-MM-dd") //输出 Date->String
    @ApiModelProperty("生日")
    private Date birth;
}