Focused backend capability

Backend-onlyReleased · Preview

Generate OpenAPI 3.1 docs for registered BTST routes.

BTST generates an OpenAPI 3.1 JSON contract from registered BTST route metadata and Zod inputs, with an optional Scalar API reference.

Best for

Backend teams that need machine-readable API documentation without adding a matching BTST client plugin.

Requires
A registered BTST backend stack to inspect
External service boundary
The optional Scalar reference loads @scalar/api-reference from jsDelivr
Ownership boundary
The schema stays at your backend base path plus the fixed /open-api/schema suffix. The optional reference defaults to /reference, and your deployment and access boundary remain yours.
Configure OpenAPI from the implementation guideView source (opens in a new tab)
Real Scalar API reference generated by the backend-only BTST OpenAPI plugin.
OpenAPI shows that a BTST plugin may add a focused backend capability without a matching client plugin.

BTST supplies

  • Deterministic OpenAPI 3.1 generation from registered route metadata and Zod inputs
  • A JSON schema endpoint at the configured API base path plus the fixed /open-api/schema suffix
  • An optional Scalar HTML reference endpoint with theme and CSP nonce options
  • Public or permission-ID access metadata for documented operations

You supply

  • A registered BTST backend stack whose routes can be inspected
  • A configured API base path; the schema suffix remains /open-api/schema
  • Optional overrides for the API title, version, and reference path; defaults are BTST API, 1.0.0, and /reference
  • A framework-level access policy if the documentation must be private

You own and customize

The schema stays at your backend base path plus the fixed /open-api/schema suffix. The optional reference defaults to /reference, and your deployment and access boundary remain yours.

Compatibility and dependencies

Maintained integrations
Next.js 15+ App Router · React Router v7 · TanStack Start
Requires
A registered BTST backend stack to inspect
External services
The optional Scalar reference loads @scalar/api-reference from jsDelivr

From registration to result

The shipped workflow

This is the feature path BTST supplies—not a claim that your app needs no integration work.

  1. Register

    Add the backend-only plugin to the existing BTST backend stack.

  2. Inspect

    Read registered endpoint metadata and Zod request schemas.

  3. Generate 3.1

    Serve a deterministic OpenAPI 3.1 document as JSON.

  4. Optionally render

    Keep JSON only or expose the Scalar reference page.

Continue your task

Move from evaluation to the right implementation boundary.

Configure OpenAPI from the implementation guideCompare OpenAPI contracts with the client Route Docs reference