框架支持
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 Actuator | Spring Boot Actuator 端点 |
| JAX-RS | Java RESTful Web 服务标准 |
| gRPC | 高性能 RPC 框架 |
| Custom | 通过规则支持项目自定义 API 约定 |
通用支持
| 框架/规范 | 说明 |
|---|---|
| javax.validation | Java Bean 验证规范 |
| Jakarta Validation | Jakarta Bean 验证规范 |
| Swagger | API 文档规范 (v2) |
| Swagger 3 / OpenAPI | API 文档规范 (v3) |
| Jackson | JSON 序列化/反序列化 |
| Gson | Google JSON 库 |
| Fastjson | Alibaba JSON 库 |
内置扩展
| 扩展 | 说明 |
|---|---|
| 废弃信息与类型转换 | 废弃信息和类型转换 |
| 字段排序 | 字段排序扩展 |
| Spring 配置 | Spring 配置属性支持 |