api-documenter

Generates Markdown or OpenAPI 3.x docs from REST/GraphQL endpoints in codebases.

8|4|Updated Feb 7, 2026
One-click install
npx skills add https://github.com/adrien-barret/claude-kit --skill api-documenter-adrien-barret
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-documenter
Source: https://github.com/adrien-barret/claude-kit/tree/main/project-template/.claude/skills/api-documenter
Command: npx skills add https://github.com/adrien-barret/claude-kit --skill api-documenter-adrien-barret

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the generation of API documentation directly from code endpoints, removing the burden of manually writing and updating docs whenever APIs change.

Core Features & Use Cases

  • Detects API routes and controllers (Express, FastAPI, Django, Spring, Go net/http, and similar frameworks) and collects endpoint information.
  • Outputs Markdown documentation or OpenAPI 3.x specifications, enabling integration with existing docs workflows.
  • Merges auto-generated sections with handwritten notes, avoiding overwrites and marking generated areas for safe updates.

Quick Start

Example: api-documenter --input ./services/api --format openapi --output docs/openapi.yaml

Frequently Asked Questions about api-documenter

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

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

You can generate API documentation from code endpoints automatically by analyzing your codebase to detect routes and controllers. This Skill outputs Markdown or OpenAPI 3.x specifications for added or changed endpoints without requiring manual writing.

Can I generate OpenAPI specifications from existing Express or FastAPI codebases?

Yes, you can generate OpenAPI specifications from existing Express, FastAPI, Django, Spring, and Go net/http codebases. The tool detects API routes and controllers across these frameworks to produce OpenAPI 3.x specs.

What is the best way to auto-generate Markdown API docs without overwriting handwritten notes?

The best way to auto-generate Markdown API docs without losing notes is to merge generated sections with existing handwritten documentation. The tool marks generated areas for safe updates and avoids overwriting your manual additions.

Does this API documentation generator support GraphQL endpoints?

Yes, this API documentation generator supports GraphQL endpoints as well as REST APIs. It applies to codebases that expose either protocol and automatically collects endpoint information to produce documentation.

How do I merge auto-generated API documentation with existing docs?

You merge auto-generated API documentation with existing docs by running the tool against your codebase. It detects new or changed endpoints and safely merges them into your current files, marking generated areas to prevent overwriting user notes.

What frameworks are supported for automating API docs generation from code?

Supported frameworks for automating API docs generation from code include Express, FastAPI, Django, Spring, and Go net/http. The tool analyzes code in these frameworks to detect routes and collect endpoint information for documentation.