Menu
Create comprehensive API documentation with examples, parameter descriptions, and interactive code samples
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
Maintains versions of skills, prompts, or documents. Provides version tagging, release management, changelogs, and rollback capabilities. Tracks changes to SKILL.md files, scripts, and resources using git-based version control with semantic versioning.
Maintains versions of skills, prompts, or documents. Provides version tagging, release management, changelogs, and rollback capabilities. Tracks changes to SKILL.md files, scripts, and resources using git-based version control with semantic versioning.
Retrieves and analyzes content from user-provided URLs or search results using the WebFetch tool. Manages domain filtering and max_uses limits to prevent data exfiltration. Use when users provide URLs to fetch, when analyzing web pages, or when following up on search results.
Process and analyze PDF documents including text extraction, table extraction, chart analysis, and visual content understanding. Use when working with PDFs, extracting structured data, generating summaries, or converting PDFs to other formats (markdown, JSON, CSV).
Analyzes and processes images using Claude's vision capabilities. Supports OCR, image classification, diagram comparison, chart analysis, visual Q&A, and more. Use when users need to understand, extract, or analyze visual content.
Condenses long documents, conversation logs, or transcripts into concise summaries. Supports retrieval from memory/files, multiple output formats (bullet points, paragraphs, executive summary), and customizable detail levels. Use when the user needs to quickly understand large amounts of text content.
| name | api-documentation |
| description | Create comprehensive API documentation with examples, parameter descriptions, and interactive code samples |
Create professional API documentation that's clear, complete, and easy to use. This skill helps you generate well-structured API docs that serve both developers and non-technical stakeholders.
This skill assists in generating and organizing API documentation that includes:
Use this skill when you need to:
When using this skill:
Endpoint: Create User
POST /api/v1/users
Description: Creates a new user account with the provided information.
Authentication: Bearer Token (required)
Request:
{
"email": "user@example.com",
"name": "John Doe",
"role": "developer"
}
Response (201 Created):
{
"id": "usr_12345",
"email": "user@example.com",
"name": "John Doe",
"role": "developer",
"created_at": "2024-01-15T10:30:00Z"
}
Error Response (400 Bad Request):
{
"error": "INVALID_EMAIL",
"message": "The provided email is invalid",
"field": "email"
}
Input:
endpoints:
- path: /api/products
method: GET
description: List all products
parameters:
- name: limit
type: integer
required: false
default: 20
Output: OpenAPI 3.0 YAML specification with all endpoints, schemas, and examples properly formatted.
This skill includes templates for:
Helper scripts include:
| Pattern | Use Case | Complexity |
|---|---|---|
| REST | General purpose APIs | Low |
| GraphQL | Complex data queries | High |
| gRPC | High-performance services | High |
| WebSocket | Real-time communication | Medium |
| OpenAPI | Standardized specification | Medium |
For help with API documentation:
assets/templates/scripts/