swagger-docs-generator
Generate Swagger/OpenAPI documentation setup for REST APIs. Triggers on "create swagger docs", "generate api documentation", "swagger setup", "openapi docs config".
When & Why to Use This Skill
This Claude skill automates the generation of Swagger and OpenAPI 3.x documentation for REST APIs. It streamlines the developer workflow by creating ready-to-use TypeScript configurations and Swagger UI setups, ensuring your API endpoints are professionally documented and easily testable.
Use Cases
- Scenario 1: Rapidly initializing interactive Swagger UI documentation for a new Express.js project to improve API discoverability.
- Scenario 2: Generating standardized OpenAPI 3.x configuration files (swagger.ts) to ensure consistency across multiple microservices.
- Scenario 3: Reducing manual boilerplate work by automatically setting up the swagger-ui-express middleware for existing RESTful services.
| name | swagger-docs-generator |
|---|---|
| description | Generate Swagger/OpenAPI documentation setup for REST APIs. Triggers on "create swagger docs", "generate api documentation", "swagger setup", "openapi docs config". |
Swagger Docs Generator
Generate Swagger UI setup and configuration for API documentation.
Output Requirements
File Output: swagger.ts with express-swagger-ui configuration
Format: Valid TypeScript
Standards: OpenAPI 3.x, swagger-ui-express
When Invoked
Immediately generate Swagger documentation setup.
Example Invocations
Prompt: "Create Swagger docs for Express API" Output: Complete Swagger UI setup with configuration.