api-docs

...

3|Updated Jan 29, 2026

Search Tags:#documentation #markdown #OpenAPI #API docs #generate #JSDoc

Ready to run

npx skills add https://github.com/peopleforrester/claude-dotfiles --skill api-docs-peopleforrester

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-docs
Source: https://github.com/peopleforrester/claude-dotfiles/tree/main/skills/documentation/api-docs
Command: npx skills add https://github.com/peopleforrester/claude-dotfiles --skill api-docs-peopleforrester

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the creation and maintenance of API documentation, reducing manual effort and inconsistencies across REST APIs, libraries, and SDKs.

Core Features & Use Cases

Auto-generate OpenAPI specifications from source code annotations and type hints.
Produce library and SDK documentation in Markdown or JSDoc formats for easy reference.
Create cross-linked, searchable reference docs with versioning and example snippets.
Use case: Document a REST API and its endpoints automatically from a codebase and keep docs in sync with changes.

Quick Start

Run the generator on your project to create API docs:

Example: api-docs analyze --input ./src --output docs/api
Review the generated docs at docs/api/index.md and refine configuration as needed.

Frequently Asked Questions about api-docs

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

FAQPage Schema

How do I generate OpenAPI specifications from source code annotations?▼

To generate OpenAPI specifications, this Skill parses source code metadata, annotations, and type hints to produce structured OpenAPI documents. It automates specification creation directly from the codebase, ensuring your API docs stay synchronized with code changes.

What is the best way to create Markdown or JSDoc references for a library API?▼

Creating Markdown or JSDoc references is achieved by parsing code metadata and schema definitions to produce structured documents. This Skill generates searchable library and SDK documentation with versioning, example snippets, and cross-links automatically.

Can I auto-generate API documentation for REST APIs and SDKs across different programming languages?▼

Auto-generating API documentation for REST APIs and SDKs across multiple languages is supported. This Skill applies to various programming environments by parsing code metadata and annotations to produce consistent, structured API references.

How do I keep my API documentation in sync with code changes automatically?▼

Keeping API documentation in sync with code changes requires parsing codebase annotations and schema definitions. This Skill automates this process by generating structured documents with versioning and cross-links directly from the updated source code.

Does this API documentation generator support creating cross-linked reference docs with examples?▼

Generating cross-linked reference docs with examples is fully supported. This Skill parses code metadata and schema definitions to produce structured documents, applying to REST APIs, library APIs, and SDKs to enable consistent reference generation.

What are the limitations of generating API docs from code annotations and type hints?▼

Generating API docs from code annotations relies on accurately parsing source code metadata and schema definitions. If the codebase lacks sufficient annotations or type hints, the resulting OpenAPI, JSDoc, or Markdown references may require manual refinement.