在开发接口时,我们希望可以把我们开发的接口直接同步到apifox上,这样团队中的成员就可以直接查看,触发接口。如何直接把接口同步到apifox上呐?
1、在apifox上新建团队
2、在新建的团队上新建项目
项目建好了,如何把接口直接同步到里面呐?我这里是基于swagger同步的,所以,在项目中要引入swagger依赖
<dependency> <groupId>org.springdoc</groupId> <!-- 接口文档 UI:默认 --> <artifactId>springdoc-openapi-ui</artifactId> <version>1.6.15</version> </dependency>
在类上使用@Tag(name = "flow")注解,在方法上使用@Operation(summary = "testSwagger"),在入参字段上加上@Schema(description = "dispatchId",requiredMode = Schema.RequiredMode.REQUIRED)注解。
3、在apifox上配置定时任务讲springboot项目中的接口导入到apifox。
接口有更新时,点击这个立即导入按钮重新拉取即可。
每个更新的接口变动可以在这里看到
返回到这里,就可以看到接口已经同步过来了。
在这里选择要执行的环境就可以了,比如本地环境,开发环境,测试环境等。
我这里选择的本地环境,直接点击发送即可,就会请求我们的本地环境了。
我们也可以分享给别人,这样大家就能在一个团队中进行开发同步了。
到这里,springboot项目中的接口同步到apifox就结束了。