spring boot 整合 springfox(swaager)

spring boot 整合 springfox(swaager)

1、引入依赖

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
</dependency>

2、在启动类上添加注解

@EnableSwagger2

在启动类添加以上注解

3、创建配置类，配置相关信息

/**
 * @author 陈明勇
 */
@Configuration
@EnableSwagger2
public class Swagger2Config {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.OAS_30)
                .select()
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
            	.apis(RequestHandlerSelectors.basePackage("com.cmy.controller"))
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .build()
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("swagger 文档标题")
                .description("swagger 文档描述")
                .version("1.0 swagger 文档版本")
                .build();
    }
}

不要忘记在配置类上添加以下注解

@Configuration
@EnableSwagger2

4、配置 controller api 接口信息

/**
 * @author 陈明勇
 */
@RestController
@RequestMapping("/user")
@Api(tags = {"用户接口tag"})
public class UserController {

    @GetMapping("/{id}")
    @ApiOperation(value = "通过 用户id 获取用户信息")
    public User get(@PathVariable("id") Long id) {
        User user = new User();
        user.setId(id);
        return user;
    }
}

在类上面添加 @Api() 注解，在接口方法上添加 @ApiOperation() 注解

5、配置 model 信息

/**
 * @author 陈明勇
 */
@Data
@ApiModel(description = "用户po")
public class User {
    @ApiModelProperty(name = "id", value = "用户id", example = "1243245436543")
    private Long id;
    @ApiModelProperty(name = "username", value = "用户名", example = "张三")
    private String username;
    @ApiModelProperty(name = "password", value = "密码", example = "123456")
    private String password;
}

在类上面添加 @ApiModel() 注解，在属性上面添加 @ApiModelProperty() 注解

效果展示

更多用法可到本人博客 swagger 专栏或者官网查看 http://springfox.github.io/springfox/docs/current/