配置knife4j来测试后端接口且生成接口文档

knife4j是swagger的升级版

1、使用方式

1)、导入Maven依赖

<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>${knife4j-spring..version}</version>

2)、在config包下创建WebMvcConfiguration类并继承WebMvcConfigurationSupport类,加入knife4j相关配置

/**
     * 通过knife4j生产接口文档
     * @return
     */
    @Bean
    public Docket docket(){
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("自定义")
                .version("2.0")
                .description("自定义")
                .build();
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .groupName("自定义")
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("Controller包位置"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

3)、设置静态资源映射,否则接口文档页面无法访问

/**
     * 通过knife4j生产接口文档
     * @return
     */
    @Bean
    public Docket docket(){
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("自定义")
                .version("2.0")
                .description("自定义")
                .build();
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .groupName("自定义")
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("前端控制器位置"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

运行项目访问路径:localhost:8080/doc.html

3、常用注解

@Api:用在类上,例如Controller,表示对类的说明

@ApiModel:用在类上,例如entity、DTO、VO

@ApiModelProperty:用在属性上,描述属性信息

@ApiOperation:用在方法上,例如Controller的方法,说明方法的用途、作用

  • 9
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值