Introduction
EasyYapi is an IntelliJ IDEA plugin that generates API documentation based on Javadoc, KDoc, and ScalaDoc.
You can get fairly complete API documentation while keeping your code zero-intrusive, but special requirements still need some special comments/annotations to cooperate. On the other hand, you can flexibly use configuration rules to adapt to your project characteristics to reduce code intrusion.
Features
- Export API documentation
- Call API directly in IDEA
- AI-assisted rule authoring — describe what you want in natural language; the assistant writes the rule file for you
- Postman environment sync — sync Postman environments to the API Dashboard with inline editing
Out of the Box
EasyApi understands standard HTTP frameworks (Spring MVC, WebFlux, JAX-RS, Feign) out of the box — most projects need no custom rules. For custom framework behaviour the scanner can't see (e.g. a jakarta.servlet.Filter that requires a header, or a ResponseBodyAdvice that wraps every response in an envelope), use the built-in AI Assistant or the external skill to detect it and generate the rule. See Rule Authoring for the guide.
Most plugin capabilities can be enabled or disabled from Settings > Other Settings > EasyApi. Use the Features tab for framework recognizers, export channels, and field-format channels; the General tab provides additional scanning and editor switches. Keep only the capabilities relevant to the current project enabled.
Supported Items
| Category | Default Support | Additional Support |
|---|---|---|
| Language | Java, Kotlin | Scala |
| Web Framework | Spring, Spring WebFlux, Feign, JAX-RS (Quarkus / Jersey), gRPC | - |
| Export Channels | Postman, YApi, Markdown, cURL, HttpClient, Hoppscotch, OpenAPI | - |
| Common Frameworks | javax.validation, Jakarta Validation, Jackson, Gson | Swagger, Fastjson |
| Features | API Call, API Dashboard, Gutter Icon Navigation, Script Executor, AI-assisted Rule Authoring | Spring Actuator |
Community
- Discuss new features or submit bugs: Issues
- Develop new features or fix bugs: Pull Requests