PaloAltoNetworks/docusaurus-openapi-docs

Health v2 · maintenance only

Adoption not part of the score

1103 stars · 314 forks observed · 2026-08-28

What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-30, confidence not recorded

A Docusaurus v3 plugin and theme that generates MDX API reference documentation from OpenAPI/Swagger specifications. It extends the Docusaurus CLI to convert specs into docs pages rendered with a matching OpenAPI-aware theme.

Use cases

• generate API reference docs from an OpenAPI spec in Docusaurus
• convert Swagger 2.0 or OpenAPI 3.x YAML into MDX documentation
• document multiple or micro OpenAPI specs in one docs site
• render API explorers with code samples from x-codeSamples
• customize API docs sidebar with tag groups and vendor extensions

When to choose

• your docs site is built with Docusaurus v3 and you need API reference pages
• you want docs generated directly from OpenAPI specs as the source of truth
• you need support for vendor extensions like x-tagGroups, x-logo, and x-codeSamples

When to avoid

• you don't use Docusaurus for your documentation site
• you need interactive API docs outside a static site generator
• you want a standalone API portal rather than docs embedded in Docusaurus

Facets

plugin · maturity active

documentation api-documentation markdown templating documentation web-development apis developer-tools cli docusaurus openapi swagger mdx api-reference-docs docs-as-code nodejs web-server

Member repositories

For agents

markdown · JSON · MCP: product_card(name="PaloAltoNetworks/docusaurus-openapi-docs")