OpenAPI Spec Reference Generator
Converts OpenAPI 3.x specification files into browsable API reference documentation using swagger-parser and redoc-cli. Generates static HTML, markdown, and Postman collection exports from YAML/JSON spec files.
npx skills add agentskillexchange/skills --skill openapi-spec-reference-generator
The OpenAPI Spec Reference Generator transforms OpenAPI 3.x specifications into comprehensive, browsable API reference documentation. It uses the swagger-parser library for spec validation and dereferencing of $ref pointers.
What this skill actually does
Documentation generation leverages redoc-cli to produce responsive static HTML pages with interactive try-it-out panels, authentication configuration, and code sample generation in multiple languages. The skill also exports Postman Collection v2.1 format for direct import into Postman workspaces.
The generator supports multi-file spec resolution, automatically resolving external $ref references across split specification files. It validates specs against the OpenAPI 3.0 and 3.1 standards, reporting structural errors and suggesting fixes.
Additional output formats include markdown suitable for GitHub wiki pages, Docusaurus MDX components, and Slate-compatible documentation. The skill handles custom x-extensions, webhook definitions, and link objects for HATEOAS-style API documentation with navigable resource relationships.