Agent skill

openapi

OpenAPI/Swagger specification, code generation, documentation, and validation.

Stars 163
Forks 31

Install this agent skill to your Project

npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/other/other/openapi

SKILL.md

OpenAPI Skill

Expert assistance for creating OpenAPI specifications and API documentation.

Capabilities

  • Write OpenAPI 3.x specifications
  • Generate client/server code
  • Create interactive documentation
  • Validate API contracts
  • Design request/response schemas

Usage

Invoke this skill when you need to:

  • Document REST APIs
  • Generate API clients
  • Validate API contracts
  • Create interactive docs

Specification Pattern

yaml
openapi: 3.0.3
info:
  title: Users API
  version: 1.0.0

paths:
  /users:
    get:
      summary: List users
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserList'

components:
  schemas:
    User:
      type: object
      required: [id, name, email]
      properties:
        id:
          type: string
        name:
          type: string
        email:
          type: string
          format: email

Best Practices

  • Use $ref for reusable schemas
  • Document all responses
  • Include examples
  • Version your specs

Target Processes

  • api-documentation
  • api-design
  • client-generation

Expand your agent's capabilities with these related and highly-rated skills.

Didn't find tool you were looking for?

Be as detailed as possible for better results