Add your API reference

1. Point at the contract

   One path, or an array — each entry becomes its own service.

   openapi: "./openapi.yaml",

2. Place it in the sidebar

   Without navigation, pages come first and the API reference follows.

   navigation: [
     "quickstart",
     { api: true, label: "API reference" },
   ],

3. Link to it from guides

   API links are checked against the contract at build time.

   Create one with [Create inbox](/api/inboxes/create-inbox).
   See the [201 response](/api/inboxes/create-inbox#response-201).

How URLs are formed

• The reference lives under /api
• Groups are tags — the group slug is the slugified tag name, in declared tag order
• Operation slugs are the operationId in kebab case, or method-path without one
• Collisions gain -2, -3 in canonical order
• Untagged operations go to an operations group, listed last

Multiple contracts

openapi: [
  "./contracts/identity.yaml",
  "./contracts/payments.yaml",
],

Contracts are never merged because their paths look alike. Local $refs resolve inside the project; remote references are disabled.

Edge cases

$ref: "https://schemas.acme.dev/inbox.yaml"

$ref: "./schemas/inbox.yaml"

[Create](/api/inboxes/create)

[Create](/api/inboxes/create-inbox)