A zero-config CLI tool that transforms Express route files into complete OpenAPI 3.0 specifications.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install swagger-gen
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install swagger-gen using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is Swagger Generator?
Swagger Generator is a developer-focused utility designed to bridge the gap between code and documentation. By analyzing Express route definitions, it automates the creation of OpenAPI 3.0 specs, ensuring your API documentation stays in sync with your codebase. This tool is a vital addition to any Openclaw Skills collection, providing a streamlined way to document request and response shapes without manual overhead.
Whether you are building a new service or maintaining a legacy API, Swagger Generator handles the heavy lifting of extracting endpoints and methods. It integrates seamlessly into modern development workflows, allowing teams to focus on building features while maintaining high-quality documentation for API consumers.
Swagger Generator Use Cases
- Generating comprehensive API documentation from existing Express routes
- Preparing specifications for Swagger UI integration
- Accelerating onboarding for new API consumers and developers
- Maintaining API-first design principles within a growing codebase
- Reducing documentation debt during rapid development cycles
How Swagger Generator Works
- The tool scans the specified directory containing Express route definitions.
- It parses the source code to extract endpoints, HTTP methods, and associated handler logic.
- It utilizes an LLM to infer request/response shapes, types, and error patterns from the code context.
- A complete OpenAPI 3.0 specification is generated in YAML or JSON format.
- The resulting file is immediately ready for use with documentation engines like Swagger UI.
Swagger Generator Setup
No persistent installation is required. Ensure you have Node.js 18+ and your OPENAI_API_KEY configured in your environment.
export OPENAI_API_KEY='your_api_key_here'
npx ai-swagger ./src/routes/
To target a specific file and define an output path:
npx ai-swagger ./src/routes/users.ts -o docs/api.yaml
Swagger Generator Data Schema & Taxonomy
Swagger Generator processes source code files and produces standard OpenAPI artifacts.
| Attribute | Description |
|---|---|
| Input | JavaScript or TypeScript files containing Express routes |
| Output | OpenAPI 3.0 Specification (YAML or JSON) |
| Metadata | Includes endpoint paths, methods, parameters, and inferred response types |
| Customization | Supports output path flags and specific file targeting |
Swagger Generator Advanced Features
- Support for single-file or directory-wide specification generation
- Intelligent type inference for complex request/response shapes using AI models
- Zero-configuration requirement for rapid deployment within Openclaw Skills workflows
- Compatibility with standard OpenAPI 3.0 consumers like Swagger UI and Redoc
- Lightweight execution via npx to prevent local dependency bloating
SKILL.md
Loading
Related Openclaw Skills
Supabase RLS Generator
A specialized developer tool that converts Prisma database schemas into production-ready Supabase Row Level Security policies.
Supabase RLS Generator
An automated utility that transforms Prisma schema definitions into robust Supabase Row Level Security (RLS) policies.
Supabase Gen
A specialized tool that parses Prisma schema files to automatically generate comprehensive Supabase Row-Level Security (RLS) policies.
Storybook Generator
Automate the creation of comprehensive Storybook stories and documentation from React components using AI-driven analysis.
Tailwind Config Generator
Automatically transform your brand hex codes into a fully-featured Tailwind CSS configuration file including full shade ranges and semantic colors.
Terraform Generator
An AI-powered CLI tool that converts natural language infrastructure descriptions into structured Terraform configuration files.
Featured*
