spring boot 整合 springfox

• spring boot 整合 springfox(swaager)
• • 1、引入依賴
  • 2、在啟動類上添加注解
  • 3、建立配置類，配置相關資訊
  • 4、配置 controller api 接口資訊
  • 5、配置 model 資訊
• 效果展示

spring boot 整合 springfox(swaager)

1、引入依賴

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

2、在啟動類上添加注解

在啟動類添加以上注解

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/