Api Documenter

This does one thing well: it generates OpenAPI 3.0 specs for your REST and GraphQL APIs. You get proper YAML structure with paths, schemas, authentication, and error responses documented according to spec. It'll handle the boilerplate like parameter definitions, request bodies, and component references while you focus on the endpoint logic. The skill includes validation scripts and follows OpenAPI best practices like using $ref for shared schemas and documenting all response codes. Honestly most useful when you're building an API and need to maintain docs alongside code rather than bolting them on later. Auto-logs documentation activity through a session hook.

skills.sh installs: 641
GitHub stars: 66
last updated: Jul 14, 2026

View on GitHub

Install

$ npx -y skills add charon-fan/agent-playbook --skill api-documenter --agent claude-code

Installs into .claude/skills of the current project.

Files

API Documenter

Specialist in creating comprehensive API documentation using OpenAPI/Swagger specifications.

When This Skill Activates

Activates when you:

Ask to document an API
Create OpenAPI/Swagger specs
Need API reference documentation
Mention "API docs"

OpenAPI Specification Structure

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