project-api

Generate and update Markdown API documentation from JavaScript and TypeScript source code.

5|1|Updated Mar 10, 2026

Search Tags:#automation #typescript #documentation #api #javascript #code-analysis

Ready to run

npx skills add https://github.com/microbians/AI.SKILLS --skill project-api-microbians

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: project-api
Source: https://github.com/microbians/AI.SKILLS/tree/main/skills/project-api
Command: npx skills add https://github.com/microbians/AI.SKILLS --skill project-api-microbians

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Auto-generates and maintains a project's public API reference by scanning source code to extract classes, functions, exports, and inheritance, ensuring up-to-date documentation across codebases.

Core Features & Use Cases

Self-healing API reference: regenerates .claude/api.md when missing or outdated to reflect current code.
Comprehensive extraction: detects class hierarchies, method signatures, constructors, exported functions, and getters/setters.
Automation-friendly: works with JavaScript/TypeScript projects and can integrate into first-session setup or CI pipelines.

Quick Start

Run the skill in your project to generate and refresh the .claude/api.md API reference.

Frequently Asked Questions about project-api

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

FAQPage Schema

How do I auto-generate API documentation from JavaScript and TypeScript source code?▼

Auto-generate API documentation by parsing JavaScript and TypeScript source files to extract classes, functions, exports, and inheritance, then writing the structured reference to a Markdown file. This ensures your project's API reference always reflects the current codebase.

What is the best way to keep API documentation up to date with changing code?▼

Keep API documentation up to date by using a self-healing automation workflow that detects missing or outdated reference files and regenerates them. It analyzes current source code structures during setup or pipeline execution to refresh the Markdown output.

Can I integrate API reference generation into my CI pipeline for TypeScript projects?▼

Yes, you can integrate API reference generation into CI pipelines. The automation workflow parses JavaScript and TypeScript codebases to detect method signatures and class hierarchies, regenerating the Markdown reference automatically whenever APIs change.

Does this API documentation generator detect class hierarchies and method signatures?▼

Yes, the API documentation generator detects class hierarchies, method signatures, constructors, exported functions, and getters/setters. It comprehensively extracts these structures from JavaScript and TypeScript source code to build a structured Markdown reference.

What file format is used for the generated API reference output?▼

The generated API reference output uses Markdown format, specifically written to the .claude/api.md file path. This structured Markdown file captures all detected classes, functions, exports, and inheritance details extracted from the source code.

When should I not use automated code analysis for API documentation?▼

Automated code analysis for API documentation may not suit projects lacking structured JavaScript or TypeScript codebases, or when custom non-standard export patterns are used. It relies on parsing standard language constructs like classes and functions to generate the Markdown reference.