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
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 | - |
| Common Frameworks | javax.validation, Jakarta Validation, Jackson, Gson | Swagger, Fastjson |
| Features | API Call, API Dashboard, Gutter Icon Navigation, Script Executor | Spring Actuator |
Community
- Discuss new features or submit bugs: Issues
- Develop new features or fix bugs: Pull Requests