EasyApiEasyApi 是什么EasyApi 是一款 IDEA 插件，他的功能是使后端开发者能更好地对接 YApi。
为什么需要对接EasyApi 插件是用来对接 YApi 的，那为啥要对接呢？或者说为啥要有接口文档呢？
我们回想一下以前的开发模式：
后端写好接口，告知前端前端看完开始写前端接口代码后端改了接口，又要重新告知前端前端根据接口修改，又要修改前端对应的代码这样沟通成本很高~
那如果有一个东西可以实时记录后端接口的话，那就减少很多沟通成本了~
使用 EasyApi插件下载、安装 EasyApi 插件安装 EasyApi 插件配置 server、token在 IDEA 设置中配置好 YApi server 和个人的 tokens
配置好 servertoken获取
token 获取代码 /**
* 这部分会变成分组名
* 这部分是分组的说明信息
*
* @Description 活动
* @Author ZhouLiangCheng
* @Date 2022/10/20
* @Version 1.0
*/
@RestController
@RequestMapping("/export/yapi")
public class ExportYapiController {
/**
* 这部分会作为api的名称
* 这部分会变成api的说明信息
*
* @param param1 参数1的描述
* @param param2 {@link DescEnum#bb}
* @param param3 {@link DescEnum#aa}
* @return desc of response
*/
@GetMapping("/get1")
public Result
@RequestParam(required = false, defaultValue = "aa") DescEnum param3) {
return Result.success("123");
}
/**
* 废弃请求
* 默认请求类型为 content-type:`application/x-www-form-urlencoded`，
* 但是标记有 @RequestBody 的参数会设置为 'application/json'
*
* @param map 任意
* @return version
* @deprecated use {@link #post2(Map)} )} instead of
*/
@Deprecated
@PostMapping("/post1")
public Result
return Result.success(1);
}
/**
* 船新版本
*
* @param map 任意
* @return version
*/
@PostMapping("/post2")
public Result
return Result.success(2);
}
@Getter
@AllArgsConstructor
public static enum DescEnum {
// desc
aa("this a"),
bb("from b"),
;
final String desc;
}
}
结果分组信息分组信息接口信息接口信息小结Yapi + EasyApi 用起来挺方便，但还是感觉功能不够完善：
没有数据库操作没有接口前后置操作可视化做的不够好
更好用的插件「Apifox Helper」Apifox 退出的能让后端开发者更方便开发、更方便生成接口文档的 IDEA 插件 —— Apifox Helper，实测确实更好用。
插件下载地址： 立即前往 。
介绍Apifox Helper 是一款集成在 IDEA 中，帮助开发者自动解析代码注解并快速生成 API 文档的便捷工具。
立即体验 ApifoxApifox Helper开发者在 IDEA 中写接口代码，可利用这个插件，将写的代码同步到 Apifox 接口文档上，而不需要开发者自己去 Apifox 上修改~
特点Apifox Helper 基于这几种技术去解析 API 文档的
javadoc（Java）KDoc（Kotlin）ScalaDoc（Scala）它支持以下几种协议框架
Spring BootSwaggerJAX-RS基本可以实现代码零入侵自动生成接口文档
安装、配置插件依次打开 Preferences(Settings) > Plugins，搜索 Apifox Helper 进行安装
安装 Apifox Helper安装完插件，此时还没搞定，还需要将你这个插件跟 Apifox 进行关联，才能达到同步效果。
依次打开 Preferences(Settings) > Apifox Helper ，并配置 Apifox 服务器地址、个人访问令牌、项目 ID：
Apifox 服务器地址： https://api.apifox.cn。Apifox 个人访问令牌： 需要到 Apifox 中，点击头像进入设置，然后进行令牌生成。模块项目 ID 配置： 需要进入 Apifox ，进入项目中「项目设置 --> 基本设置」，复制项目 ID 粘贴过来。配置 Apifox Helper
API 文档生成右键点击 Upload to Apifox 就可以根据接口代码生成 Apifox 接口文档，方便整个团队的开发进行接口查看、维护、测试~
API 文档生成API 文档一键同步当你修改了接口代码是，只需要重新右键点击 Upload to Apifox 就可以完成 API 文档的一键同步啦~
API 文档一键同步大大提高开发效率！后端负责接口代码同步到 API 文档，前端查看接口并调试，测试进行自动化测试~
提高效率总结Apifox = Postman + Swagger + Mock + JMeter
Apifox 比起 Yapi 真的有过之而无不及，功能很完善~可以实现 API 文档、API 调试、API Mock、 API 自动化测试，是更先进的 API 设计/开发/测试工具。
通过 Apifox 可以在统一的平台上设计、调试、测试以及协作你的 API，消除了在不同工具之间切换和数据不一致的问题。 简化了你的 API 工作流，并确保了前端、后端和测试人员之间的高效协作，点击免费使用。
立即体验 ApifoxApifox