OpenAPI integration

You can generate a complete API reference from an OpenAPI specification. Drop your spec file into your content directory, configure it in docs.json, and blode.md creates a page for every operation.

Setup

Add your spec file

Place an openapi.yaml or openapi.json file in your content directory:

docs.json

index.mdx

openapi.yaml

Configure in docs.json

Add the api.openapi section to your docs.json:


{
  "api": {
    "openapi": {
      "source": "openapi.yaml",
      "directory":

Published with Edda

Field	Type	Description	Required	Default
`source`	string	Path to your OpenAPI spec file, relative to the content directory.	Yes	—
`directory`	string	URL path prefix for generated API pages. Defaults to "api".	Yes	"api"
`include`	string[]	Filter which operations to include. Accepts an array of operation IDs or path patterns.	Yes	—
`basePath`	string	Override the base path for API requests in the playground.	Yes	—


{
  "api": {
    "openapi": {
      "source": "openapi.yaml",
      "directory": "api"
    },
    "playground": {
      "display": "interactive",
      "proxy": "https://api.your-domain.test",
      "credentials": true
    }
  }
}

Mode	Behavior
`interactive`	Full playground with editable parameters and a "Send" button.
`simple`	Read-only display of request and response examples.
`auth`	Interactive playground that requires authentication before sending.
`none`	No playground. Only the endpoint documentation is shown.

OpenAPI integration

Setup

OpenAPI integration

Setup

Configuration options

Navigation

API playground

Display modes