SpringBoot整合Knife4jSpringBoot整合Knife4j

75 阅读 0 评论 50 点赞

我是靠谱客的博主温婉烧鹅，这篇文章主要介绍SpringBoot整合Knife4jSpringBoot整合Knife4j，现在分享给大家，希望可以做个参考。

SpringBoot整合Knife4j

POM依赖

注意： 不能与Swagger2依赖一起使用，否则会报错

复制代码

1
2
3
4
5
6
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>3.0.2</version>
</dependency>

开启Knife4j配置

复制代码

1
2
3
4
5
6
7
8
@SpringBootApplication
@EnableKnife4j
public class RedisDemo {
    public static void main(String[] args) {
        SpringApplication.run(RedisDemo.class,args);
    }
}

编写Knife4j配置类

Knife4j配置类与Swagger2配置类差不多，Knife4j是在Swagger2基础上美化了接口文档界面。

注意：.apis(RequestHandlerSelectors.basePackage(“com.x.controller”)) == 自行修改

复制代码

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
/**
 * SwaggerUI配置
 */
@Configuration
public class SwaggerUIConfig {
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.x.controller")) // 自行修改！
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 项目基本信息配置
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("项目标题")
                .description("项目描述")
                .termsOfServiceUrl("http://www.example.com")
                //填写项目联系人信息（名称、网址、邮箱）
                .contact(new Contact("czk", "czk.com", "czk@163.com"))
                //填写项目版本号
                .version("1.0")
                .build();
    }
}

常用注解使用

@APi：用于控制层
@ApiOperation：接口方法
@ApiImplicitParams：接口参数（多参数，方法上）
@ApiImplicitParam：接口参数（单参数，方法上）
@ApiParam：接口参数（参数上）
@ApiModel：数据类上
@ApiModelProperty：数据类属性上

复制代码

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
@RestController
@RequestMapping("user")
@Api(tags = "College控制器")
public class UserController {

    @Resource
    IUserService userService;

    @PostMapping("add")
    @ApiOperation(value = "添加用户",notes = "czk")
    public ResponseData add( @RequestBody UserAddVO userAddVO) {
    }


    @DeleteMapping("delete/{uid}")
    @ApiOperation(value = "删除用户",notes = "czk")
    @ApiImplicitParam(name = "uid",value = "用户ID",required = true,paramType = "path")
    public ResponseData delete(@PathVariable("uid") Integer uid) {
    }


    @PutMapping("update")
    @ApiOperation(value = "根据ID修改用户",notes = "czk")
    public ResponseData update(@RequestBody UserUpdateVO userUpdateVO) {
    }

    @GetMapping("queryById")
    @ApiOperation(value = "根据ID查询用户",notes = "czk")
    public ResponseData queryById(@RequestParam("uid") Integer uid) {
    }
}

复制代码

1
2
3
4
5
6
7
8
9
10
@ApiModel(value = "ResponseDate",description = "统一前端响应格式")
public final class ResponseData<T> {
    @ApiModelProperty(name = "code",value = "响应代码", example = "200")
    private Integer code;
    @ApiModelProperty(name = "msg",value = "响应信息",example = "添加成功")
    private String msg;
    @ApiModelProperty(name = "data",value = "响应数据",example = "响应数据/空")
    private T data;
}

复制代码

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
@Data
@ApiModel(value = "UserAddVO" ,description = "添加用户表单VO")
public class UserAddVO {

    @ApiModelProperty(name = "username",value = "账户",required = true)
    private String username;

    @ApiModelProperty(name = "password",value = "密码",required = true)
    private String password;

    @ApiModelProperty(name = "realName",value = "使用者")
    private String realName;

    @ApiModelProperty(name = "ageApiModelTest",value = "测试Integer类型ApiModel",required = false,allowEmptyValue = true,allowableValues = "range(1,150)")
    private Integer ageApiModelTest;
}

复制代码

1
2
3
4
5
6
7
8
9
10
11
12
13
14
@Data
@ApiModel(value = "UserUpdateVO" ,description = "更新用户表单VO")
public class UserUpdateVO {

    @ApiModelProperty(name = "password",value = "密码",required = true)
    private Long uid;

    @ApiModelProperty(name = "password",value = "密码",required = true)
    private String password;

    @ApiModelProperty(name = "realName",value = "使用者")
    private String realName;
}