Usage

OneAPI.app generates API documentation from Java source code. No backend code changes, no running application required.

1. Install Java

Skip if java -version prints a version. OneAPI uses Java to parse .java files and decompile JARs.

java -version

Download: Oracle JDK

2. Install Maven

Skip if mvn -versionprints a version. Copy your backend team's settings.xml to ~/.m2/settings.xml.

mvn -version

3. Install OneAPI CLI

npm install -g oneapi-cli

4. CLI commands

oneapi analysis

Parse a Java project into OneAPI JSON Schema.

  • -p (required) — backend project path
  • -o (required) — output dir for oneapi.json
oneapi analysis -p /path/to/project -o ./out

oneapi service

Generate frontend TypeScript services.

  • -s (required) — path to oneapi.json
  • -r (required) — request import string
  • -o (required) — output dir (cleared on each run)
oneapi service -s ./oneapi.json -r 'import request from "@/utils/request";' -o ./services

oneapi openapi

Convert to OpenAPI 3.0 JSON Schema.

  • -s (required) — path to oneapi.json
  • -o (required) — output dir for openapi.json
oneapi openapi -s ./oneapi.json -o ./out

5. Using with UmiJS

npm i oneapi-umijs-plugin --save

Add to config/config.ts:

plugins: ['oneapi-umijs-plugin'],
oneapi: {
  requestLibPath: "import { request } from 'umi';",
  schemaPath: "../oneapi-site/docs/oneapi.json",
}

Docs route available at /umi/plugin/oneapi in dev.