---
name: "swagger-openapi-redoc-generator"
description: "Generate clean, three-panel interactive API documentation from OpenAPI specifications."
metadata:
  author: "Redocly"
  version: "1.0.0"
  runtime_compatibility:
    - "codex"
    - "claude-code"
    - "cursor"
    - "windsurf"
triggers:
  - "generate api docs with redoc"
  - "convert openapi to redoc html"
  - "customize redoc theme"
permissions:
  fs_read: true
  fs_write: "workspace"
  shell_exec: false
  net_access: false
---

# Redoc Interactive API Reference Generator

Renders OpenAPI 3.0 and 3.1 YAML/JSON specs into three-panel documentation portals with Redoc: search bar, navigation tree, schema models, and interactive code samples.

## When to Invoke
Invoke this skill whenever you need to:
- generate api docs with redoc
- convert openapi to redoc html
- customize redoc theme

## Execution SOP & Rules
1. Include the Redoc standalone JS bundle or use the @redocly/cli CLI tool.
2. Compile standalone documentation with redocly build-docs openapi.yaml -o index.html.
3. Configure theme options (colors, fonts, spacing) via redocly.yaml or inline HTML attributes.
4. Validate the source OpenAPI specification with redocly lint prior to document generation.

## Verification Checklist
- Run local linting, syntax validation, and type-checks before reporting completion.
- Ensure all created or modified files adhere to workspace boundaries and avoid uncommitted secrets.
- Verify tests or build commands exit cleanly with return code 0.