Skip to content

介绍 ​

EasyYapi 是一个 IntelliJ IDEA 插件,基于 Javadoc、KDoc 和 ScalaDoc 解析生成 API 文档。

你可以在保持代码零侵入的情况下得到相当完整的 API 文档,但是特殊的需求还是需要部分特殊的注释/注解配合。与之相对的是,你可以灵活地运用配置规则来适应你的项目特性以减少代码侵入。

功能特性 ​

开箱即用 ​

EasyApi 开箱即用地支持标准 HTTP 框架(Spring MVC、WebFlux、JAX-RS、Feign)—— 大多数项目无需自定义规则。对于扫描器无法察觉的自定义框架行为(例如要求添加请求头的 jakarta.servlet.Filter,或将每个响应包装在信封中的 ResponseBodyAdvice),可使用内置的 AI 助手或外部 skill 来检测并生成规则。完整指南请参见 规则编写。

大部分插件能力都可以在 Settings > Other Settings > EasyApi 中启用或关闭。使用 Features 标签页管理框架识别器、导出渠道和字段格式化渠道;General 标签页还提供扫描和编辑器行为开关。你可以只保留当前项目需要的能力。

支持项列表 ​

类别默认支持额外支持
语言Java, KotlinScala
Web 框架Spring、Spring WebFlux、Feign、JAX-RS (Quarkus / Jersey)、gRPC-
导出渠道Postman、YApi、Markdown、cURL、HttpClient、Hoppscotch、OpenAPI、ApiPost-
常用框架javax.validation、Jakarta Validation、Jackson、GsonSwagger、Fastjson
功能特性API 调用、API Explorer、Search Everywhere、编辑器行标记导航、脚本执行器、AI 辅助规则编写Spring Actuator

社区 ​

贡献者 ​

基于 Apache-2.0 许可发布