| name | openapi-spec-generator |
| description | Automated OpenAPI specification generation from code annotations, comments, and interface definitions |
| allowed-tools | ["Read","Write","Edit","Glob","Grep","Bash"] |
| graph | {"domains":["domain:software-engineering"],"specializations":["specialization:sdk-platform-development"],"skillAreas":["skill-area:api-design","skill-area:api-doc-generation"],"roles":["role:platform-engineer"],"topics":["topic:api-design","topic:developer-experience"]} |
OpenAPI Spec Generator Skill
Overview
This skill automates the generation of OpenAPI 3.x specifications from code annotations, comments, and interface definitions. It parses source code to extract API endpoints, schemas, and documentation to produce comprehensive and accurate API specifications.
Capabilities
- Parse code to extract API endpoints and schemas from annotations
- Generate OpenAPI 3.x specifications in YAML or JSON format
- Validate spec completeness and correctness against OpenAPI standards
- Auto-update specs from code changes with incremental generation
- Support multiple frameworks (Express, FastAPI, Spring, ASP.NET, etc.)
- Extract request/response schemas from TypeScript types, Python type hints, Go structs
- Generate examples from code-level documentation
Target Processes
- API Design Specification
- API Documentation System
- SDK Code Generation Pipeline
Integration Points