Back to Skills

api-documentation-generator

luongnv89
Updated 3 days ago
61 views
228
25
228
View on GitHub
Metawordapi

About

This skill generates comprehensive API documentation from source code, including OpenAPI specifications and endpoint details. It's ideal for creating or updating API docs when users mention endpoints or documentation needs. The tool produces structured documentation with parameters, responses, and code examples for each endpoint.

Quick Install

Claude Code

Recommended
Plugin CommandRecommended
/plugin add https://github.com/luongnv89/claude-howto
Git CloneAlternative
git clone https://github.com/luongnv89/claude-howto.git ~/.claude/skills/api-documentation-generator

Copy and paste this command in Claude Code to install this skill

Documentation

API Documentation Generator Skill

Generates

  • OpenAPI/Swagger specifications
  • API endpoint documentation
  • SDK usage examples
  • Integration guides
  • Error code references
  • Authentication guides

Documentation Structure

For Each Endpoint

## GET /api/v1/users/:id

### Description
Brief explanation of what this endpoint does

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | string | Yes | User ID |

### Response

**200 Success**
```json
{
  "id": "usr_123",
  "name": "John Doe",
  "email": "john@example.com",
  "created_at": "2025-01-15T10:30:00Z"
}

404 Not Found

{
  "error": "USER_NOT_FOUND",
  "message": "User does not exist"
}

Examples

cURL

curl -X GET "https://api.example.com/api/v1/users/usr_123" \
  -H "Authorization: Bearer YOUR_TOKEN"

JavaScript

const user = await fetch('/api/v1/users/usr_123', {
  headers: { 'Authorization': 'Bearer token' }
}).then(r => r.json());

Python

response = requests.get(
    'https://api.example.com/api/v1/users/usr_123',
    headers={'Authorization': 'Bearer token'}
)
user = response.json()

GitHub Repository

luongnv89/claude-howto
Path: 03-skills/doc-generator

Related Skills

content-collections

Meta

This skill provides a production-tested setup for Content Collections, a TypeScript-first tool that transforms Markdown/MDX files into type-safe data collections with Zod validation. Use it when building blogs, documentation sites, or content-heavy Vite + React applications to ensure type safety and automatic content validation. It covers everything from Vite plugin configuration and MDX compilation to deployment optimization and schema validation.

View skill

creating-opencode-plugins

Meta

This skill provides the structure and API specifications for creating OpenCode plugins that hook into 25+ event types like commands, files, and LSP operations. It offers implementation patterns for JavaScript/TypeScript modules that intercept and extend the AI assistant's lifecycle. Use it when you need to build event-driven plugins for monitoring, custom handling, or extending OpenCode's capabilities.

View skill

evaluating-llms-harness

Testing

This Claude Skill runs the lm-evaluation-harness to benchmark LLMs across 60+ standardized academic tasks like MMLU and GSM8K. It's designed for developers to compare model quality, track training progress, or report academic results. The tool supports various backends including HuggingFace and vLLM models.

View skill

langchain

Meta

LangChain is a framework for building LLM applications using agents, chains, and RAG pipelines. It supports multiple LLM providers, offers 500+ integrations, and includes features like tool calling and memory management. Use it for rapid prototyping and deploying production systems like chatbots, autonomous agents, and question-answering services.

View skill