接口测试swagger

本文介绍了如何在SpringBoot项目中集成knife4j(Swagger的增强版),包括添加依赖、配置YML文件、使用Api注解详细描述API及其参数,并展示了在Controller层面的实际应用和访问SwaggerUI的方法。
摘要由CSDN通过智能技术生成

knife4j(swagger的本地增强解决方案)
1首先引入依赖,在pom.xml引入,引入完成后记得重新加载一下。
引入不成功的话换一个版本


```xml
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-openapi2-spring-boot-starter</artifactId>
    <version>4.0.0</version>
</dependency>

2依赖注入完成后,配置yml文件
application.yml或者application.propertie,自己的配置不动,加入下面的代码

knife4j:
  enable: true    #此项必配置,否则knife4j运行有问题

3

在Controller类和方法上使用
序列注解作用
1@Api(tags = “Knife4jController接口类”)
2@Api修饰整个类,描述api(Controller)的作用
3@ApiOperation描述一个类的一个方法,或者说一个接口
4@ApiImplicitParam多个请求参数的描述信息
5@ApiImplicitParam(name = “name”,value=“请求的名称”,required = true)单个参数的描述信息
6@ApiIgnore使用该注解忽略这个API
7@ApiError发生错误返回的信息
``

4在页面输入你的配置文件中的地址加上端口号/doc.html,你就可以进入使用了
例子
image-20230628120930193

在controller层使用的例子

使用swagger的例子
image-20230628121224269

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值