Springboot集成swagger,使用apifox导入接口

文章介绍了如何在Springboot项目中引入swagger的依赖,通过添加注解来标注接口、方法和参数,以生成API文档。启动项目后,访问/v3/api-docs获取文档,并在Apifox中导入,完成API的管理和测试。
摘要由CSDN通过智能技术生成

Springboot+swagger+apifox

一、前提准备。

已经创建好了基本的包目录

下面详细步骤:

一、引入swagger依赖

         <!-- swagger3-openapi依赖包 -->
        <dependency>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-ui</artifactId>
            <version>1.6.11</version>
            <exclusions>
                <exclusion>
                    <artifactId>swagger-ui</artifactId>
                    <groupId>org.webjars</groupId>
                </exclusion>
            </exclusions>
        </dependency>

二、分别在controller类上面,方法上面,参数加swagger对应注解注解:


// 作用在controller类上面,指定目录
@Tag(name = "学校模块/学生管理")

// 作用在controller方法上面,说明方法作用
@Operation(summary = "查询所有学生")

// 作用在controller方法参数里面,说明参数
@Parameter(name = "id", description = "学生id", required = true)

// 作用在入参或出参类的属性上面,说明属性的含义
@Schema(description = "学生id")

三、启动项目

四、使用apifox手动添加接口,访问地址:http://127.0.0.1:8080/v3/api-docs

输入地址:http://127.0.0.1:8080/v3/api-docs,点击提交

 

 然后点击确认导入

五‘导入成功

 

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值