API Documentation

by huangjia2019

API Documentation is a Writing skill for Claude Code, published by huangjia2019 in claude-code-engineering.

1.1K stars379 forkson huangjia2019/claude-code-engineeringAdded 2026/08/21Repository updated 2026/07/23

View source on GitHub Download repo ZIP

agentagentic-aiaiclaudeclaude-codeclaude-skills

Install in seconds

Install API Documentation

Copy API Documentation into your Claude Code skills folder. Run the command in your terminal, or review the source on GitHub before installing.

terminal

npx degit https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/02-progressive-skill ~/.claude/skills/02-progressive-skill

Requires Node.js. Downloads this skill only — not the rest of the repository — into your Claude Code skills folder.

Without Node.js

git clone https://github.com/huangjia2019/claude-code-engineering.git

Clones the whole repository, then copy the skill’s own directory into your skills folder yourself.

In this catalog

Source file: 04-Skills/projects/02-progressive-skill/SKILL.md in huangjia2019/claude-code-engineering
Installs to: ~/.claude/skills/02-progressive-skill
Collection: One of 13 skills cataloged from this repository
Category: Writing — 1012 skills

What API Documentation does

API Documentation generates markdown API references from source code. Use it to document endpoints, parameters, request and response schemas, or produce OpenAPI/Swagger specs.

API Documentation is cataloged under Writing on DirSkills. API Documentation comes from a repository tagged agent, agentic-ai, ai, claude and claude-code.

Documentation

README

Excerpt

API Documentation Generator

Generate comprehensive API documentation from source code.

Quick Reference

For common documentation patterns, see PATTERNS.md.

Documentation Standards

See STANDARDS.md for our documentation conventions.

Process

Step 1: Identify API Endpoints

Look for:

Route definitions (Express, FastAPI, etc.)
Controller methods
Handler functions

Step 2: Extract Information

For each endpoint, extract:

HTTP method (GET, POST, PUT, DELETE, etc.)
Path/route
Parameters (path, query, body)
Request/response schemas
Authentication requirements

Step 3: Generate Documentation

Use the template in templates/endpoint.md for consistent formatting.

Step 4: Create Overview

This is the opening of the README. Read the full README on GitHub.

Frequently asked about API Documentation

What else does huangjia2019 publish alongside API Documentation?
API Documentation is one of 13 skills that DirSkills catalogs from huangjia2019/claude-code-engineering, the repository it ships in. Its siblings there include API Conventions, API Documentation Generator and API Documentation Generator. Each one is a separate skill with its own page in this directory, installs the same way API Documentation does, and is maintained by huangjia2019 in that same repository. The rest of the collection is listed on the huangjia2019/claude-code-engineering page.
How does API Documentation compare to other Writing skills?
API Documentation ranks #423 by stars among the 1012 Writing skills in this catalog. The most-starred ones next to it are Article Writing, Social Media Content Calendar and Knowledge Comic Creator. DirSkills ranks by the star count of the repository each skill ships in, so that order reflects how popular those repositories are rather than any review of API Documentation against them. Open each page to compare what they document and how they install.