work_docs_api-docs

Identify and document API endpoints from source code into structured references.

1|Updated Apr 16, 2026
One-click install
npx skills add https://github.com/JoNaYeon/claude-code-skills --skill work-docs-api-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: work_docs_api-docs
Source: https://github.com/JoNaYeon/claude-code-skills/tree/main/work/docs/work_docs_api-docs
Command: npx skills add https://github.com/JoNaYeon/claude-code-skills --skill work-docs-api-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Analyzing source code to produce structured API documentation that keeps endpoints, parameters, and responses in sync with the codebase, reducing manual documentation effort and drift.

Core Features & Use Cases

  • Endpoint discovery across routers/controllers and serverless functions.
  • Automatic generation of endpoint descriptions, parameters, responses, and authentication notes.
  • Use Case: You add a new route in your API; this skill updates or creates an API reference page with all details automatically.

Quick Start

Generate a complete API reference from the provided source code.

Frequently Asked Questions about work_docs_api-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically generate API documentation from source code?

Endpoint discovery works by scanning source code for routers, controllers, and serverless functions to map all API endpoints. It groups endpoints logically and extracts parameter mappings, response descriptions, and error handling details directly from the codebase.

Can I generate API references for serverless functions and multiple languages?

Yes, API reference generation applies to projects with serverless functions, routes, or controllers across multiple programming languages. It handles endpoint grouping, parameter mapping, and error coverage regardless of the specific language framework used.

What is the best way to keep API documentation in sync with my codebase?

The best way to keep API documentation in sync with your codebase is to generate it directly from the source code. This ensures endpoint descriptions, parameters, and responses stay aligned with code changes, reducing drift and manual update effort.

How do I document authentication notes and error handling for my API endpoints?

Documenting authentication notes and error handling for API endpoints involves analyzing source code to identify security requirements and error response patterns. The generated reference automatically includes these details alongside parameter and response descriptions for each endpoint.

Does automated endpoint discovery work with existing routes and controllers?

Yes, automated endpoint discovery works with existing routes and controllers by analyzing the source code structure. It identifies all API endpoints and produces a structured reference with endpoint grouping, parameter mapping, and clear error coverage for your project.