springboot工程中knife4j的使用

测试接口需要swagger,目前knife4j是封装swagger比较好用的。
1.如何在springboot工程中,引入knife4j的坐标?
一个是可以去https://mvnrepository.com/网站上,搜索knife4j,查看最新版本,复制坐标的写法到springboot工程 pom.xml文件即可。或者用csda的AI 输入问题,即可找到答案,比如:‘knife4j的配置’:
在这里插入图片描述

2.引入了knife4j后,启动下工程,看是否顺利启动?
我在引入了knife4j后,启动工程发现报错:
报错:failed to start bean ‘documentationPlugingsBootstrapper’
启动报错了。啥原因呢?网上查找了一些解决方案,我尝试了下,确实解决了问题,但这种解决方式的原来到底是什么,我还不清楚,如果有能解答的,欢迎留言,帮我答疑解惑!我对原理方面的研究还是少些。解决上面问题的具体方法是:在application.yml配置文件中,添加如下修改,即mvc匹配策略的设置:
在这里插入图片描述

3.knife4j坐标完成后,如何配置?

我使用的是配置类的方式:

@Configuration
@EnableSwagger2
@EnableKnife4j
public class KnifeConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.wrs.project"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("wrs工作效率系统API文档")
                .description("API文档")
                .termsOfServiceUrl("")
                .version("1.0")
                .build();
    }
}

4.关于接口扫描路径

上面代码配置的是 com.wrs.project
这是我的工程地址:这样配置,即可以扫描到project及其子包下面的所有接口。

5.对接口做些配置

@Api( tags =  "销售合同相关接口")
public class SaleContractController extends BaseController{
 	@ApiOperation("查询所有销售合同")
    @GetMapping("/list")
    public ......Result getList(){
    }
}

@API(tags = “xxxxx”):这个配置属性加到类上面
@ApiOperation(“查询所有销售合同”):这个配置属性加到方法上面

6.运行系统,输入http://localhost:7070/doc.html

在这里插入图片描述
注释:7070是我自己系统的端口号,按自己需求配置端口号即可。

这样写完接口后,可以根据接口设计要求,利用knife4j进行接口测试,测试成功后,进行前后端联调!

  • 8
    点赞
  • 10
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值