API Documentation

API Documentation Skill

Generate professional API documentation following industry standards.

OpenAPI 3.0 Format

openapi: 3.0.0
info:
  title: Your API Name
  version: 1.0.0
  description: Clear API description

servers:
  - url: https://api.example.com/v1

paths:
  /users:
    get:
      summary: List all users
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'

components:
  schemas:
    User:
      type: object
      required:
        - id
        - email
      properties:
        id:
          type: string
        email:
          type: string

Documentation Checklist

• Endpoint path and HTTP method
• Clear summary (1 line)
• Detailed description (2-3 sentences)
• All query/path/header parameters documented
• Request body schema (if applicable)
• All response status codes
• Response schemas
• Authentication requirements
• Rate limiting information
• Example requests and responses

Converted and distributed by TomeVault — claim your Tome and manage your conversions.