# PaloAltoNetworks/docusaurus-openapi-docs

🦝 OpenAPI plugin for generating API reference docs in Docusaurus v3.

Repository: https://github.com/PaloAltoNetworks/docusaurus-openapi-docs
Canonical: https://ross.abutalabs.com/products/docusaurus-openapi-docs
Homepage: https://docusaurus-openapi.tryingpan.dev
Language: TypeScript
License: MIT
License Family: permissive
Topics: docusaurus, docusaurus-plugin, docusaurus-theme, docusaurus2, openapi, react
Last push: 2026-08-25T11:28:01+00:00

## Health v2 (maintenance only)
Score: 98/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 99, release rhythm 97, longevity 100
- inputs: {"age_days": 1659, "days_push": 8, "days_rel": 22, "gap_med": 14.0, "n_releases_24m": 23}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1103, forks 314 (observed 2026-08-28T04:03:36.049713+00:00)

## What it is
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
- artifact type: plugin
- maturity: active
- function: documentation, api-documentation, markdown, templating
- domain: documentation, web-development, apis, developer-tools
- platform: cli
- tags: docusaurus, openapi, swagger, mdx, api-reference-docs, docs-as-code, nodejs, web-server

## Member repositories
- PaloAltoNetworks/docusaurus-openapi-docs (main) score 98

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:03:36.049713+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T06:45:31.370832+00:00, confidence not recorded.
  - readme: https://github.com/PaloAltoNetworks/docusaurus-openapi-docs (fetched 2026-08-28T04:03:36.049713+00:00, sha 4a8333ee33ec)
  - homepage: https://docusaurus-openapi.tryingpan.dev (fetched 2026-08-29T12:48:14.159507+00:00, sha 770aa97b6900)
  - site_page: https://docusaurus-openapi.tryingpan.dev/tags/documentation (fetched 2026-08-29T12:48:14.169923+00:00, sha 4a2848251e80)
  - site_page: https://docusaurus-openapi.tryingpan.dev/tags/getting-started (fetched 2026-08-29T12:48:14.171715+00:00, sha e52f36b74f1f)
  - site_page: https://docusaurus-openapi.tryingpan.dev/tags/quickstart (fetched 2026-08-29T12:48:14.173264+00:00, sha 3c8017a86f5d)
- Data as of 2026-08-30T08:39:29.467469+00:00.