Agent skill

openapi-spec-design-first-apis

[STUB - Not implemented] OpenAPI 3.1.0 design-first API specifications as single source of truth. PROACTIVELY activate for: [TODO: Define on implementation]. Triggers: [TODO: Define on implementation]

View SKILL.md on GitHub Repository
Stars 163
Forks 31

Install this agent skill to your Project

npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/data/openapi-spec-design-first-apis

SKILL.md

OpenAPI Spec Design-First APIs

STUB: This skill is not yet implemented

This placeholder preserves the documented plugin structure. See parent plugin README for planned capabilities.

Planned Capabilities

  • Design-First Approach: API specification before implementation
  • OpenAPI 3.1.0 Compliance: Latest specification features
  • Schema component reuse and references
  • Request/response examples
  • Authentication scheme definitions
  • API versioning strategies

Example Structure

yaml
openapi: 3.1.0
info:
  title: User API
  version: 1.0.0
paths:
  /users:
    get:
      summary: List users
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'

Anti-Patterns

  • API implementation before specification
  • Inconsistent error response formats
  • Missing authentication documentation

Implementation Status

  • Core implementation
  • References documentation
  • Output templates
  • Integration tests

Didn't find tool you were looking for?

Be as detailed as possible for better results