easy-api

English | 中文

Feature

• Export API Doc ToPostman
• Export API Doc ToMarkdown

	Support	Extended Support
language	java, kotlin	scala
web	spring, feign, jaxrs (quarkus or jersey)	dubbo
channels	Postman, Markdown , Curl , HttpClient	-
frameworks	javax.validation, Jackson, Gson	swagger

AI Powered (Beta)

EasyAPI includes powerful AI capabilities to enhance your API documentation workflow:

Features

• API Translation: Automatically translate your API documentation to different languages, preserving technical terms while providing natural language translations.
• Method Return Type Inference: Use AI to analyze method code and more accurately infer complex return types, improving API documentation accuracy.

Configuration

• Support for Multiple AI Providers: Configure your preferred AI provider (OpenAI, DeepSeek, etc.) and models ( GPT-4, DeepSeek-V3, etc.).
• API Response Caching: Optimize performance by caching AI responses for identical requests.

To enable these features, configure your AI provider and API token in the EasyAPI settings dialog.

Navigation

• Guide
• Installation
• Quick Start
• Config
• Demo

Run application

• ./gradlew :idea-plugin:runIde will runs an IDEA instance with the EasyApi installed.
• ./gradlew clean test will run all test case.

Requirements

• IDE: Intellij Idea Ultimate / Intellij Idea Community 2021.2.1 or higher
• JDK: Version 11 or higher

Compatibility

JDK	IDE	status
11	2021.2.1	✓
15	2022.2.3	✓
17	2023.1.3	✓

Javadoc

• wiki
• oracle

KDoc

• kotlin-doc

Contributing

You can propose a feature request opening an issue or a pull request.

Here is a list of contributors: