Swagger / springdoc 的 Java 替代方案

一款不需要 改代码、也不需要启动应用

OneAPI.app 通过 AST 分析,直接从 Java 源码生成 OpenAPI 3.0 文档。无需 @Operation 注解、不耦合 Spring、不必启动服务。代码即文档。

开始使用在线演示npm install -g oneapi-cli
终端
$ oneapi analysis -p ./spring-boot-demo -o .
✅ OneAPI Schema 解析完成(8s): ./oneapi.json

$ oneapi openapi -s ./oneapi.json -o .
✅ openapi.json 生成成功(OpenAPI 3.0)

$ oneapi service -s ./oneapi.json -r 'import request from "@/utils/request";' -o .
✅ 前端 services 已生成: ./services

为什么开发者选择它

零接入成本

Swagger 与 springdoc-openapi 的直接替代品。不改一行业务代码、不加任何注解,把 OneAPI 指向你的项目即可生成文档。

代码即文档

文档直接源自 Java 源码与 Javadoc。能编译的,就能被文档化——不再有代码与文档的漂移,也无需维护独立规格文件。

易扩展

同一份 oneapi.json 同时驱动后端 OpenAPI 输出与前端 service 代码(TypeScript),可接入 UmiJS、Postman 或你自己的工具链。

工作原理

01

解析

oneapi analysis 解析 Java 项目(并反编译 JAR 获取三方类型)生成 oneapi.json。

oneapi analysis -p <项目> -o <目录>
02

生成 OpenAPI

oneapi openapi 输出 OpenAPI 3.0 文件,可导入任意工具。

oneapi openapi -s oneapi.json -o <目录>
03

生成前端 service

oneapi service 从同一份 schema 生成带类型的 TypeScript service 函数。

oneapi service -s oneapi.json -r '<request 导入>' -o <目录>

Swagger 注解就是技术债

你写的每一个 @Schema 都是需要维护的代码,而每个文档页都依赖一个正在运行的服务。OneAPI 把这两条都去掉了。

查看完整对比 →

常见问题

几分钟生成你的第一份 OpenAPI 文档

安装 CLI,指向任意 Spring Boot 项目——无需任何注解。

开始使用