From charon-fan-agent-playbook
Creates OpenAPI/Swagger specifications for REST and GraphQL APIs, including endpoint summaries, parameters, schemas, responses, and best practices.
npx claudepluginhub zhaono1/agent-playbookThis skill is limited to using the following tools:
Specialist in creating comprehensive API documentation using OpenAPI/Swagger specifications.
Generates API reference documentation with OpenAPI/Swagger specs, REST/GraphQL endpoints, authentication, examples, SDKs, rate limits, and versioning. Use for REST APIs, GraphQL schemas, or OpenAPI specs.
Creates professional API documentation from OpenAPI specs with endpoints, authentication, and interactive examples. Use for documenting REST APIs, SDK references, or developer portals.
Generates OpenAPI 3.0+ specs from existing API code, enhances with schemas/examples/errors, creates interactive docs/SDKs, and validates compliance.
Share bugs, ideas, or general feedback.
Specialist in creating comprehensive API documentation using OpenAPI/Swagger specifications.
Activates when you:
openapi: 3.0.3
info:
title: API Title
version: 1.0.0
description: API description
servers:
- url: https://example.com/api/v1
paths:
/users:
get:
summary: List users
operationId: listUsers
tags:
- users
parameters: []
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/User'
components:
schemas:
User:
type: object
properties:
id:
type: string
name:
type: string
For each endpoint, document:
/users/{id}:
get:
summary: Get a user by ID
operationId: getUserById
description: Retrieves a single user by their unique identifier
tags:
- users
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The user ID
responses:
'200':
description: User found
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'404':
description: User not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
User:
type: object
required:
- id
- email
properties:
id:
type: string
format: uuid
description: Unique user identifier
example: "550e8400-e29b-41d4-a716-446655440000"
email:
type: string
format: email
description: User's email address
example: "user@example.com"
createdAt:
type: string
format: date-time
description: Account creation timestamp
Document auth requirements:
security:
- bearerAuth: []
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: Use your JWT token from /auth/login
Standard error format:
components:
schemas:
Error:
type: object
properties:
error:
type: string
description: Error message
code:
type: string
description: Application-specific error code
details:
type: object
description: Additional error details
Common HTTP status codes:
Generate OpenAPI spec from code:
python scripts/generate_openapi.py
Validate OpenAPI spec:
python scripts/validate_openapi.py openapi.yaml
references/openapi-template.yaml - OpenAPI templatereferences/examples/ - API documentation examples