This project provides an IntelliJ IDEA plugin to automatically generate API documentation from Java and Kotlin code, supporting various web frameworks and export formats like Postman, Yapi, Markdown, and Curl. It targets Java/Kotlin developers seeking to streamline API documentation creation and improve collaboration by offering a unified, code-driven documentation solution.

How It Works

EasyYAPI leverages static code analysis within the IntelliJ IDEA environment to parse Java and Kotlin source files. It identifies API endpoints, request/response structures (using Jackson, Gson, and validation annotations), and method signatures. The plugin then transforms this information into structured API documentation formats, including AI-powered features for translation and return type inference.

Quick Start & Requirements

• Primary install: Run ./gradlew :idea-plugin:runIde within IntelliJ IDEA.
• Prerequisites: IntelliJ IDEA Ultimate/Community 2021.2.1 or higher, JDK 11 or higher.
• AI Features: Requires configuration of AI provider (OpenAI, DeepSeek) and API token.

Highlighted Details

• Supports Java and Kotlin languages.
• Integrates with Spring, Feign, JAX-RS, and Dubbo.
• Exports to Postman, Yapi, Markdown, Curl, and HttpClient formats.
• AI-powered features include API translation and method return type inference.

Maintenance & Community

Contributions are welcomed via issues or pull requests. A list of contributors is available.

Licensing & Compatibility

The project does not explicitly state a license in the provided README. Compatibility is confirmed for JDK 11-17 and IntelliJ IDEA versions 2021.2.1 through 2023.1.3.

Limitations & Caveats

The AI-powered features are noted as being in Beta. The README does not specify compatibility beyond JDK 17 or IntelliJ IDEA 2023.1.3.