介绍
EasyYapi 是一个 IntelliJ IDEA 插件，基于 Javadoc、KDoc 和 ScalaDoc 解析生成 API 文档。
你可以在保持代码零侵入的情况下得到相当完整的 API 文档，但是特殊的需求还是需要部分特殊的注释/注解配合。与之相对的是，你可以灵活地运用配置规则来适应你的项目特性以减少代码侵入。
功能特性
- 导出 API 文档
- 在 IDEA 中直接发起 API 请求
- AI 辅助规则编写——用自然语言描述需求，助手为你生成规则文件
- Postman 环境同步——将 Postman 环境同步到 API Dashboard，支持内联编辑
开箱即用
EasyApi 开箱即用地支持标准 HTTP 框架（Spring MVC、WebFlux、JAX-RS、Feign）—— 大多数项目无需自定义规则。对于扫描器无法察觉的自定义框架行为（例如要求添加请求头的 jakarta.servlet.Filter，或将每个响应包装在信封中的 ResponseBodyAdvice），可使用内置的 AI 助手或外部 skill 来检测并生成规则。完整指南请参见 规则编写。
大部分插件能力都可以在 Settings > Other Settings > EasyApi 中启用或关闭。使用 Features 标签页管理框架识别器、导出渠道和字段格式化渠道；General 标签页还提供扫描和编辑器行为开关。你可以只保留当前项目需要的能力。
支持项列表
| 类别 | 默认支持 | 额外支持 |
|---|---|---|
| 语言 | Java, Kotlin | Scala |
| Web 框架 | Spring、Spring WebFlux、Feign、JAX-RS (Quarkus / Jersey)、gRPC | - |
| 导出渠道 | Postman、YApi、Markdown、cURL、HttpClient、Hoppscotch、OpenAPI | - |
| 常用框架 | javax.validation、Jakarta Validation、Jackson、Gson | Swagger、Fastjson |
| 功能特性 | API 调用、API Dashboard、编辑器行标记导航、脚本执行器、AI 辅助规则编写 | Spring Actuator |