OpenAPI in NextGuide
Turn OpenAPI JSON or YAML into a documentation-ready model.
API documentation from your OpenAPI file
NextGuide includes its OpenAPI parser and the API reference components in the same npm package.
import { createOpenAPI } from "nextguide/openapi"
const api = createOpenAPI({ source: "content/openapi.yaml", allowRemote: false })
const model = await api.parse()
The returned model contains typed operations, paths, parameters, request bodies and response schemas. Render that data with OpenAPI components from nextguide/components.
Default recommendation: keep your specification checked into your repository and use allowRemote: false unless you intentionally need to fetch a remote document.
The API reference demo on this site uses an explicitly fictional sample API to demonstrate how the renderer looks. These routes are examples, not live NextGuide endpoints.