OpenAPI Spec Generation
openapi-spec-generation
Generate and maintain OpenAPI 3.1 specifications from code, design-first specs, and validation patterns. Use when creating API documentation, generating SDKs, or ensuring API contract compliance.
SKILL.md
Full skill instructions
OpenAPI Spec Generation
Comprehensive patterns for creating, maintaining, and validating OpenAPI 3.1 specifications for RESTful APIs.
Use this skill when
- Creating API documentation from scratch
- Generating OpenAPI specs from existing code
- Designing API contracts (design-first approach)
- Validating API implementations against specs
- Generating client SDKs from specs
- Setting up API documentation portals
Do not use this skill when
- The task is unrelated to openapi spec generation
- You need a different domain or tool outside this scope
Instructions
- Clarify goals, constraints, and required inputs.
- Apply relevant best practices and validate outcomes.
- Provide actionable steps and verification.
- If detailed examples are required, open
resources/implementation-playbook.md.
Resources
resources/implementation-playbook.mdfor detailed patterns and examples.
<!-- AGI-INTEGRATION-START -->
AGI Framework Integration
Adapted for @techwavedev/agi-agent-kit Original source: antigravity-awesome-skills
Memory-First Protocol
Retrieve prior API design decisions, database schema choices, and error handling patterns. Cache API response templates for consistent error formatting.
# Check for prior backend/API context before starting
python3 execution/memory_manager.py auto --query "API design patterns and architecture decisions for Openapi Spec Generation"
Storing Results
After completing work, store backend/API decisions for future sessions:
python3 execution/memory_manager.py store \
--content "API architecture: REST with HATEOAS, JWT auth, rate limiting at 100 req/min per tenant" \
--type decision --project <project> \
--tags openapi-spec-generation backend
Multi-Agent Collaboration
Share API contract changes with frontend agents so they update their client code, and with QA agents for test coverage.
python3 execution/cross_agent_context.py store \
--agent "<your-agent>" \
--action "Implemented API endpoints — 5 new routes with OpenAPI spec and integration tests" \
--project <project>
Agent Team: Code Review
After implementation, dispatch code_review_team for two-stage review (spec compliance + code quality) before merging.
