documenting-apis

Community

Codebase-driven API docs.

Authorthkt
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Automates generation of API specifications by analyzing code for REST endpoints, type definitions, and schemas, producing consistent docs.

Core Features & Use Cases

  • Endpoints discovery with method, path, handler
  • Type definitions and OpenAPI/Swagger generation
  • Output-ready Markdown API docs for teams and docs sites

Quick Start

Run the docs:api command to generate docs. The output is a Markdown document in the docs structure and can be consumed by /docs:api.

Dependency Matrix

Required Modules

tree-sitter-analyzerjq

Components

scriptsreferences

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: documenting-apis
Download link: https://github.com/thkt/claude-config/archive/main.zip#documenting-apis

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.