Claude Cursor Skill

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.

LLM Mart · 0 points · 18 views 0 listing impressions 0 install-command copies
Download wshobson-agents-plugins_documentation-generation_skills_openapi-spec-generation-46891e7.zip · 7 KB

Install

skills CLI npx skills add https://github.com/wshobson/agents/tree/main/plugins/documentation-generation/skills/openapi-spec-generation
Claude Code claude plugin marketplace add https://llmmart.ai/marketplace.json && claude plugin install wshobson-agents@llmmart
Git git clone https://github.com/wshobson/agents.git

The skills CLI installs just this skill, for any of its supported agents. Claude Code installs the whole wshobson/agents collection as a plugin from our marketplace. Git is the plain clone.

Skill manifest

OpenAPI Spec Generation

Comprehensive patterns for creating, maintaining, and validating OpenAPI 3.1 specifications for RESTful APIs.

When to Use This Skill

  • 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

Core Concepts

1. OpenAPI 3.1 Structure

openapi: 3.1.0
info:
  title: API Title
  version: 1.0.0
servers:
  - url: https://api.example.com/v1
paths:
  /resources:
    get: ...
components:
  schemas: ...
  securitySchemes: ...

2. Design Approaches

Approach Description Best For
Design-First Write spec before code New APIs, contracts
Code-First Generate spec from code Existing APIs
Hybrid Annotate code, generate spec Evolving APIs

Templates and detailed worked examples

Full template library and detailed worked examples live in references/details.md. Read that file when you need the concrete templates.

Best Practices

Do's

  • Use $ref - Reuse schemas, parameters, responses
  • Add examples - Real-world values help consumers
  • Document errors - All possible error codes
  • Version your API - In URL or header
  • Use semantic versioning - For spec changes

Don'ts

  • Don't use generic descriptions - Be specific
  • Don't skip security - Define all schemes
  • Don't forget nullable - Be explicit about null
  • Don't mix styles - Consistent naming throughout
  • Don't hardcode URLs - Use server variables
Files (agents)
  • references
    • code-first-and-tooling.md 11.5 KB
      Loading…
    • details.md 11.6 KB
      Loading…
  • SKILL.md 2 KB
    ---
    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.
    ---
    
    # OpenAPI Spec Generation
    
    Comprehensive patterns for creating, maintaining, and validating OpenAPI 3.1 specifications for RESTful APIs.
    
    ## When to Use This Skill
    
    - 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
    
    ## Core Concepts
    
    ### 1. OpenAPI 3.1 Structure
    
    ```yaml
    openapi: 3.1.0
    info:
      title: API Title
      version: 1.0.0
    servers:
      - url: https://api.example.com/v1
    paths:
      /resources:
        get: ...
    components:
      schemas: ...
      securitySchemes: ...
    ```
    
    ### 2. Design Approaches
    
    | Approach         | Description                  | Best For            |
    | ---------------- | ---------------------------- | ------------------- |
    | **Design-First** | Write spec before code       | New APIs, contracts |
    | **Code-First**   | Generate spec from code      | Existing APIs       |
    | **Hybrid**       | Annotate code, generate spec | Evolving APIs       |
    
    ## Templates and detailed worked examples
    
    Full template library and detailed worked examples live in `references/details.md`. Read that file when you need the concrete templates.
    
    ## Best Practices
    
    ### Do's
    
    - **Use $ref** - Reuse schemas, parameters, responses
    - **Add examples** - Real-world values help consumers
    - **Document errors** - All possible error codes
    - **Version your API** - In URL or header
    - **Use semantic versioning** - For spec changes
    
    ### Don'ts
    
    - **Don't use generic descriptions** - Be specific
    - **Don't skip security** - Define all schemes
    - **Don't forget nullable** - Be explicit about null
    - **Don't mix styles** - Consistent naming throughout
    - **Don't hardcode URLs** - Use server variables
    

Comments (0)

Sign in to join the conversation.

No comments yet.

Reviews (0)

No reviews yet.