Showcasing APIs with Starlight OpenAPI

Jan 7, 2026

My Name

Content Creator

For REST APIs, an OpenAPI (Swagger) specification is the gold standard. starlight-openapi allows you to render these specifications directly within your Starlight documentation site.

Features

Schema Rendering: Beautifully formatted API endpoints and models.
Sidebar Integration: Adds API categories to your navigation.
Multiple Schemas: Support for documenting multiple APIs.

How to use

Have your openapi.json or openapi.yaml ready.
Install the plugin:

npm install starlight-openapi

Configure it:

import starlightOpenAPI from 'starlight-openapi';

// ...
plugins: [
  starlightOpenAPI([
    {
      base: 'api',
      label: 'My API',
      schema: './src/openapi.yaml',
    },
  ]),
],

Your API documentation will now be accessible under /api!