API Documentation Generator

Genereert API-routes naar markdown/OpenAPI; scaffoldt geen nieuwe endpointcode.

Door huangjia2019 · huangjia2019/claude-code-engineering

Werkt met setup ★ 8.0/10

API Documentation Generator — Genereert API-routes naar markdown/OpenAPI; scaffoldt geen nieuwe endpointcode.

Wat het doet

Scant bestaande route handlers (Express, FastAPI, Spring Boot, Go) op methode, pad, parameters en authenticatie, vult vervolgens een gebundeld endpoint.md-sjabloon in naar markdown-documentatie of een OpenAPI 3.0-specificatie; levert een echte detect_routes.py-scanner en een validate_openapi.sh-checker die beide zelfstandig draaien. De eigen frontmatter overdrijft: het zegt 'gebruik wanneer de gebruiker nieuwe API-eindpunten wil maken, route handlers wil genereren, REST API's wil scaffolden', maar de body documenteert alleen eindpunten die al bestaan — er is geen code-generatiestap. De gebundelde sjablonen/openapi.yaml is ook geen geldig YAML zoals geleverd; de {PLACEHOLDER}-tokens zijn letterlijk, dus de eigen validator weigert deze totdat je ze invult.

Testrapport

De gebundelde scripts live uitgevoerd: detect_routes.py vond correct alle 4 routes in twee testbestanden, maar validate_openapi.sh struikelde over de eigen sjablonen/openapi.yaml van de skill — de {PLACEHOLDER}-tokens zijn ongeldige YAML flow-mapping keys, dus het gebundelde sjabloon faalt de gebundelde validator totdat je het eerst handmatig invult. (Hier vermeld onder onze oudere naam; de eigen naam van de skill is "API Documentation Generator".)

Getest op: 2026-07-14 · Claude Code 2.x (agent harness)

Installatie

git clone https://github.com/huangjia2019/claude-code-engineering
cd claude-code-engineering
mkdir -p ~/.claude/skills
cp -r 04-Skills/projects/05-api-generator ~/.claude/skills/api-docs-generator

Commando's en voorbeeldprompts

  • /api-docs-generatorGenereert API-routes naar markdown/OpenAPI; scaffoldt geen nieuwe endpointcode.

Skills reageren op gewone verzoeken — geen commando's om te onthouden. Na installatie activeren prompts zoals deze de skill (in het Engels):

  • Generate reference docs from these route handlers
  • Document this API's endpoints from the schema files
  • Produce endpoint documentation for my REST API code