Spec0docs
API Reference

API Reference

Per-operation reference pages for every Spec0 public API. Auto-generated from the OpenAPI specs under `public/openapi-specs/`.

The Spec0 platform ships three OpenAPI surfaces. Every operation has its own page in the sidebar, with parameters, request/response schemas, and example payloads.

Surfaces

  • Platform public registry — programmatic access to the API registry. Used by published API consumers and the public-registry web pages.
  • CLI ↔ backend — the contract @spec0/cli is generated from. Stable for CLI authors and CI integrations.
  • Mock server admin — lifecycle calls (create, refresh, list, delete) for mock servers.

If you want to try a request interactively, the Scalar playground is a single-page view with a built-in request runner. Use this section for deep links, search, and per-endpoint anchors.

Regenerating

Edit a YAML under public/openapi-specs/ and run:

npm run generate:openapi-pages

Pages here are committed so spec changes show up in PR diffs.

Using the Mock URL in Your Application

Previous Page

Create or fetch default mock server for API

Next Page

On this page

SurfacesRegenerating