The Complete Production SOP: How to Deploy and Run Redoc Interactive API Reference Generator in Autonomous AI Agents

---
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: true
  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.

extends:
  - recommended
theme:
  openapi:
    colors:
      primary:
        main: '#1a56db'
    sidebar:
      backgroundColor: '#f8fafc'
      width: '260px'
    typography:
      fontSize: '15px'
      fontFamily: 'Inter, sans-serif'

#!/usr/bin/env bash
set -euo pipefail

SPEC_FILE="openapi.yaml"
OUTPUT_FILE="public/docs/index.html"

# Lint the specification
npx @redocly/cli lint "$SPEC_FILE"

# Compile standalone bundle
mkdir -p "$(dirname "$OUTPUT_FILE")"
npx @redocly/cli build-docs "$SPEC_FILE" --config=redocly.yaml -o "$OUTPUT_FILE"
echo "API documentation successfully generated at $OUTPUT_FILE"

#!/usr/bin/env bash
if [ ! -f public/docs/index.html ]; then
  echo "Error: Documentation file was not created." >&2
  exit 1
fi

if [ $(wc -c < public/docs/index.html) -lt 5000 ]; then
  echo "Error: Generated documentation is suspiciously small or empty." >&2
  exit 1
fi

echo "Verification passed: Standalone Redoc bundle generated successfully."