Openapi Spec Generation
Unverified●30/40Claude Code◐PartialHas SKILL.md but declares no allowed-tools — Claude Code will ask for permission each time
Cursor◐PartialPlain prose you can paste in — but no Cursor rules file
Codex◐PartialPlain prose you can paste in — but no AGENTS.md
Gemini CLI◐PartialPlain prose you can paste in
Copilot◐PartialPlain prose you can paste in — but no Copilot instructions file
npx agentalley add openapi-spec-generationWho is stuck, and on what
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.
The whole source
Frontmatter — 2 properties
| 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. |
| 1 | --- |
| 2 | name: openapi-spec-generation |
| 3 | 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. |
| 4 | ---A5 — No allowed-tools declared — no way to tell what this skill may touch |
| 5 | |
| 6 | # OpenAPI Spec Generation |
| 7 | |
| 8 | Comprehensive patterns for creating, maintaining, and validating OpenAPI 3.1 specifications for RESTful APIs. |
| 9 | |
| 10 | ## When to Use This Skill |
| 11 | |
| 12 | - Creating API documentation from scratch |
| 13 | - Generating OpenAPI specs from existing code |
| 14 | - Designing API contracts (design-first approach) |
| 15 | - Validating API implementations against specs |
| 16 | - Generating client SDKs from specs |
| 17 | - Setting up API documentation portals |
| 18 | |
| 19 | ## Core Concepts |
| 20 | |
| 21 | ### 1. OpenAPI 3.1 Structure |
| 22 | |
| 23 | ```yaml |
| 24 | openapi: 3.1.0 |
| 25 | info: |
| 26 | title: API Title |
| 27 | version: 1.0.0 |
| 28 | servers: |
| 29 | - url: https://api.example.com/v1 |
| 30 | paths: |
| 31 | /resources: |
| 32 | get: ... |
| 33 | components: |
| 34 | schemas: ... |
| 35 | securitySchemes: ... |
| 36 | ``` |
| 37 | |
| 38 | ### 2. Design Approaches |
| 39 | |
| 40 | | Approach | Description | Best For | |
| 41 | | ---------------- | ---------------------------- | ------------------- | |
| 42 | | **Design-First** | Write spec before code | New APIs, contracts | |
| 43 | | **Code-First** | Generate spec from code | Existing APIs | |
| 44 | | **Hybrid** | Annotate code, generate spec | Evolving APIs | |
| 45 | |
| 46 | ## Templates and detailed worked examples |
| 47 | |
| 48 | Full template library and detailed worked examples live in `references/details.md`. Read that file when you need the concrete templates. |
| 49 | |
| 50 | ## Best Practices |
| 51 | |
| 52 | ### Do's |
| 53 | |
| 54 | - **Use $ref** - Reuse schemas, parameters, responses |
| 55 | - **Add examples** - Real-world values help consumers |
| 56 | - **Document errors** - All possible error codes |
| 57 | - **Version your API** - In URL or header |
| 58 | - **Use semantic versioning** - For spec changes |
| 59 | |
| 60 | ### Don'ts |
| 61 | |
| 62 | - **Don't use generic descriptions** - Be specific |
| 63 | - **Don't skip security** - Define all schemes |
| 64 | - **Don't forget nullable** - Be explicit about null |
| 65 | - **Don't mix styles** - Consistent naming throughout |
| 66 | - **Don't hardcode URLs** - Use server variables |
| 67 |
Reviews
Installed this one?Write the first review and take the Trailblazer badge.
Alternatives
Research Review via External Reviewer Backend (ultra reasoning)Get a deep critical review of research from an external reviewer backend (Codex or manual). Use when user says "review my research", "help me review", "get external review", or wants critical feedback on research ideas, papers, or experimental results.●····●38/40Training CheckPeriodically check WandB metrics during training to catch problems early (NaN, loss divergence, idle GPUs). Avoids wasting GPU hours on broken runs. Use when training is running and you want automated health checks.●····●37/40Changelog AutomationAutomate changelog generation from commits, PRs, and releases following Keep a Changelog format. Use when setting up release workflows, generating release notes, or standardizing commit conventions.◐····●36/40Hermes Tweet> Install and operate Hermes Tweet, a Hermes Agent plugin for X/Twitter research, timeline reading, tweet analysis, and approval-gated private or state-changing operations. Use this skill when installing Hermes Tweet, researching X/Twitter accounts, monitoring launch signals, investigating mentions, auditing giveaways, or preparing gated X operations. Use proactively when a Hermes Agent workflow needs current X/Twitter context. Requires XQUIK_API_KEY for read and action tools.◐····●36/40