Back to Skills

api-documentation-generator

verified

Generate OpenAPI/Swagger specifications and API documentation from code or design. Use when creating API docs, generating OpenAPI specs, or documenting REST APIs.

View on GitHub

Marketplace

fastagent-marketplace

armanzeroeight/fastagent-plugins

Plugin

api-toolkit

API Development

Repository

armanzeroeight/fastagent-plugins
20stars

plugins/api-toolkit/skills/api-documentation-generator/SKILL.md

Last Verified

January 21, 2026

Install Skill

Select agents to install to:

Scope:
npx add-skill https://github.com/armanzeroeight/fastagent-plugins/blob/main/plugins/api-toolkit/skills/api-documentation-generator/SKILL.md -a claude-code --skill api-documentation-generator

Installation paths:

Claude
.claude/skills/api-documentation-generator/
Powered by add-skill CLI

Instructions

# API Documentation Generator

Generate OpenAPI/Swagger specifications and comprehensive API documentation.

## Quick Start

Create OpenAPI 3.0 specs with paths, schemas, and examples for complete API documentation.

## Instructions

### OpenAPI 3.0 Structure

**Basic structure:**
```yaml
openapi: 3.0.0
info:
  title: API Name
  version: 1.0.0
  description: API description
servers:
  - url: https://api.example.com/v1
paths:
  /users:
    get:
      summary: List users
      responses:
        '200':
          description: Success
components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
```

### Info Section

```yaml
info:
  title: E-commerce API
  version: 1.0.0
  description: |
    REST API for e-commerce platform.
    
    ## Authentication
    Use Bearer token in Authorization header.
    
    ## Rate Limiting
    1000 requests per hour per API key.
  contact:
    name: API Support
    email: api@example.com
    url: https://example.com/support
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
```

### Servers

```yaml
servers:
  - url: https://api.example.com/v1
    description: Production
  - url: https://staging-api.example.com/v1
    description: Staging
  - url: http://localhost:3000/v1
    description: Development
```

### Paths and Operations

**GET endpoint:**
```yaml
paths:
  /users:
    get:
      summary: List users
      description: Retrieve a paginated list of users
      tags:
        - Users
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
        - name: per_page
          in: query
          schema:
            type: integer
            default: 20
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                 

Validation Details

Front Matter
Required Fields
Valid Name Format
Valid Description
Has Sections
Allowed Tools
Instruction Length:
8332 chars