README_CN.md

easy-yapi

English | 中文

功能特点

• 导出API文档
• 发送API请求

	支持	扩展支持
语言	java, kotlin	scala
Web框架	spring, feign, jaxrs (quarkus 或 jersey)	dubbo
导出渠道	Postman, Yapi, Markdown , Curl , HttpClient	-
支持的框架	javax.validation, Jackson, Gson	swagger

AI增强 (Beta)

EasyYAPI可以通过接入AI生成更好API文档：

特性

• API翻译：导出API文档时, 自动将API文档翻译成指定语言。
• 方法返回类型推断：使用AI分析方法代码并更准确地推断复杂返回类型，提高 API 文档的准确性。

配置

• 支持多种AI提供商：可以配置AI提供商（OpenAI, DeepSeek 等）和模型（GPT-4, DeepSeek-V3 等）。
• API响应缓存：通过缓存相同请求的AI响应来优化性能。

要启用这些功能，请在IDEA中配置AI提供商。

导航

• 指南
• 安装
• 使用
• 设置
• 示例

运行应用

• ./gradlew :idea-plugin:runIde 将运行一个安装了 EasyYapi 的 IDEA 实例。
• ./gradlew clean test 将运行所有测试用例。

环境要求

• IDE: Intellij Idea Ultimate / Intellij Idea Community 2021.2.1 或更高版本
• JDK: 11 或更高版本

兼容性

JDK	IDE	状态
11	2021.2.1	✓
15	2022.2.3	✓
17	2023.1.3	✓

Javadoc

• wiki
• oracle
• 百科

KDoc

• kotlin-doc

贡献

您可以通过提出 issue 或提交 pull request 来提出功能请求。

以下是贡献者列表：