Skip to content

框架支持

EasyApi 开箱即用地支持标准 HTTP 框架(Spring MVC、WebFlux、JAX-RS、Feign)—— 大多数项目无需自定义规则。对于扫描器无法察觉的自定义框架行为(例如要求添加请求头的 jakarta.servlet.Filter,或将每个响应包装在信封中的 ResponseBodyAdvice),可使用内置的 AI 助手或外部 skill 来检测并生成规则。完整指南请参见 规则编写

EasyYapi 支持多种 Java/Kotlin Web 框架,可以自动识别框架注解并生成对应的 API 文档。

默认支持

框架说明
Spring Boot最广泛使用的 Java Web 框架
Spring Boot WebFlux响应式 Web 框架
Spring Cloud OpenFeign声明式 HTTP 客户端
Spring ActuatorSpring Boot Actuator 端点
JAX-RSJava RESTful Web 服务标准
gRPC高性能 RPC 框架
Custom通过规则支持项目自定义 API 约定

通用支持

框架/规范说明
javax.validationJava Bean 验证规范
Jakarta ValidationJakarta Bean 验证规范
SwaggerAPI 文档规范 (v2)
Swagger 3 / OpenAPIAPI 文档规范 (v3)
JacksonJSON 序列化/反序列化
GsonGoogle JSON 库
FastjsonAlibaba JSON 库

内置扩展

扩展说明
废弃信息与类型转换废弃信息和类型转换
字段排序字段排序扩展
Spring 配置Spring 配置属性支持

基于 Apache-2.0 许可发布