Skip to content

Framework Support

EasyApi understands standard HTTP frameworks out of the box — you do not need any configuration or rule files to export APIs from projects using them. EasyApi automatically recognizes the framework's annotations and generates the corresponding API documentation.

Default Support

FrameworkDescription
Spring MVCMost widely used Java web framework (@RestController, @RequestMapping, etc.)
Spring WebFluxReactive web framework (Mono / Flux / Publisher)
Spring ActuatorSpring Boot Actuator endpoints
FeignSpring Cloud OpenFeign client interfaces (@FeignClient)
JAX-RSJava RESTful Web Services standard (Quarkus / Jersey)
gRPCHigh-performance RPC framework

When You Need Custom Rules

For the frameworks above, export works without any rule files. You only need custom rules when something changes the request/response contract invisibly — for example a servlet filter that requires a header, or a response wrapper that envelopes every response. In those cases, use the built-in AI Assistant or the external skill to detect the pattern and generate the rule.

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.