37 lines
1.2 KiB
Markdown
37 lines
1.2 KiB
Markdown
---
|
|
name: openapi-spec-generation
|
|
description: "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."
|
|
risk: unknown
|
|
source: community
|
|
date_added: "2026-02-27"
|
|
---
|
|
|
|
# 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.md` for detailed patterns and examples.
|