Skip to content

Framework Support ​

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.

EasyYapi supports multiple Java/Kotlin web frameworks and can automatically recognize framework annotations to generate corresponding API documentation.

Default Support ​

FrameworkDescription
Spring BootMost widely used Java web framework
Spring Boot WebFluxReactive web framework
Spring Cloud OpenFeignDeclarative HTTP client
Spring ActuatorSpring Boot Actuator endpoints
JAX-RSJava RESTful Web Services standard
gRPCHigh-performance RPC framework
CustomRule-driven support for project-specific API conventions

Common Support ​

Framework/SpecDescription
javax.validationJava Bean Validation specification
Jakarta ValidationJakarta Bean Validation specification
SwaggerAPI documentation specification (v2)
Swagger 3 / OpenAPIAPI documentation specification (v3)
JacksonJSON serialization/deserialization
GsonGoogle JSON library
FastjsonAlibaba JSON library

Built-in Extensions ​

ExtensionDescription
Deprecated & ConvertsDeprecated info and type conversions
Field OrderField ordering extensions
Spring ConfigurationSpring config properties support

Released under the Apache-2.0 License.