# Astro OpenAPI

Build API reference pages from OpenAPI documents inside Astro documentation sites.

import { Callout, Card, CardGrid } from '@prosefly/astro-components';

<Callout type="warning" title="Sponsor only">
  Astro OpenAPI is a private Prosefly package. Access is available to Prosefly sponsors; it is not an open-source
  package.
</Callout>

<Callout type="tip" title="Use Lotus Pro directly">
  If you are building a product documentation site, start with the Lotus Pro template. It already includes Astro OpenAPI
  and the surrounding API reference routes. You can also [view the live API
  reference](https://astro-theme-lotus.prosefly.dev/api/) to see the result.
</Callout>

## API references that stay in your docs

Astro OpenAPI turns an OpenAPI file into structured Astro content entries. You
can then use the same docs shell, navigation, Markdown, and deployment flow as
the rest of your site.

<CardGrid>
  <Card icon="lucide:download" title="Install privately" href="/docs/astro-openapi/installation/">
    Configure GitHub Packages access, then install the package with pnpm.
  </Card>
  <Card icon="lucide:settings-2" title="Configure the loader" href="/docs/astro-openapi/configuration/">
    Choose the OpenAPI source, URL base, operation groups, and route names.
  </Card>
  <Card icon="lucide:braces" title="Render API details" href="/docs/astro-openapi/components/">
    Compose request, response, security, schema, and code-example components.
  </Card>
  <Card
    icon="lucide:external-link"
    title="View the API demo"
    href="https://astro-theme-lotus.prosefly.dev/api/"
    external
  >
    Explore the API reference generated by the Lotus Pro template.
  </Card>
</CardGrid>