Swagger UI Deployer

DevOps & Security

swagger-ui-deployer

Swagger UI Deployer is an Agent Skill for devops & security published in the a5c-ai/babysitter repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Deploy interactive API documentation using Swagger UI with custom branding

View on GitHub ↗

QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

Open your project in Codex.
Copy and paste the prompt below.
Review files and risks before approving any action.

Prompt to paste

Inspect the Agent Skill at https://github.com/a5c-ai/babysitter/blob/HEAD/library/specializations/software-architecture/skills/swagger-ui-deployer/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/swagger-ui-deployer, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Swagger UI Deployer Skill

Overview

Deploys interactive API documentation using Swagger UI with configuration options, custom branding, and static HTML generation.

Capabilities

Deploy interactive API documentation
Configure Swagger UI options
Generate static HTML documentation
Custom branding and theming support
Multiple spec file support
Authentication configuration
Deep linking support

Target Processes

api-design-specification

Input Schema

{
  "type": "object",
  "required": ["specPath"],
  "properties": {
    "specPath": {
      "type": "string",
      "description": "Path to OpenAPI specification"
    },
    "outputDir": {
      "type": "string",
      "description": "Output directory for static files"
    },
    "config": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "description": "Documentation title"
        },
        "deepLinking": {
          "type": "boolean",
          "default": true
        },
        "displayOperationId": {
          "type": "boolean",
          "default": false
        },
        "defaultModelsExpandDepth": {
          "type": "number",
          "default": 1
        }
      }
    },
    "branding": {
      "type": "object",
      "properties": {
        "logo": { "type": "string" },
        "primaryColor": { "type": "string" },
        "favicon": { "type": "string" }
      }
    }
  }
}

Output Schema

{
  "type": "object",
  "properties": {
    "outputDir": {
      "type": "string"
    },
    "indexPath": {
      "type": "string"
    },
    "files": {
      "type": "array",
      "items": { "type": "string" }
    }
  }
}

Usage Example

{
  kind: 'skill',
  skill: {
    name: 'swagger-ui-deployer',
    context: {
      specPath: 'api/openapi.yaml',
      outputDir: 'docs/api',
      config: {
        title: 'My API Documentation',
        deepLinking: true
      },
      branding: {
        primaryColor: '#3b82f6'
      }
    }
  }
}