API Reference
The AppBahn API documentation is auto-generated from the OpenAPI specification and is always up to date with the running instance.
Interactive API Docs
Section titled “Interactive API Docs”Every running AppBahn instance exposes interactive API documentation powered by Scalar at:
https://<your-instance>/docs/apiUse the Scalar UI to explore endpoints, view request/response schemas, and try out API calls directly from your browser.
OpenAPI Specifications
Section titled “OpenAPI Specifications”AppBahn defines two OpenAPI specs:
- Public API (
api/public-api.yaml) — the primary API for workspaces, projects, environments, resources, and user management. - Internal API (
api/internal-api.yaml) — used for operator-to-platform communication.
These specs are the source of truth for all generated clients (TypeScript, Go) and server stubs (Spring Boot).
Generated Clients
Section titled “Generated Clients”| Client | Source | Usage |
|---|---|---|
| TypeScript | Generated from public-api.yaml | Web console (Vue.js) |
| Go | Generated from public-api.yaml | CLI tool |
| Spring | Generated from both specs | Backend server stubs |