SkillProof tested Claude skills

API Documentation Generator

Dokumentiert bestehende API-Routen in Markdown/OpenAPI; erstellt keinen neuen Endpunktcode.

von huangjia2019 · huangjia2019/claude-code-engineering

Funktioniert mit Setup ★ 8.0/10

API Documentation Generator — Dokumentiert bestehende API-Routen in Markdown/OpenAPI; erstellt keinen neuen Endpunktcode.

Was es kann

Scannt bestehende Routenhandler (Express, FastAPI, Spring Boot, Go) auf Methode, Pfad, Parameter und Authentifizierung, füllt dann eine gebündelte endpoint.md-Vorlage in Markdown-Dokumente oder eine OpenAPI 3.0-Spezifikation; liefert einen echten detect_routes.py-Scanner und einen validate_openapi.sh-Checker, die beide eigenständig laufen. Seine eigene Frontmatter überschätzt: Sie besagt 'verwenden, wenn der Benutzer neue API-Endpunkte erstellen, Routenhandler generieren, REST-APIs-Gerüste erstellen möchte', aber der Body dokumentiert nur Endpunkte, die bereits existieren – es gibt keinen Code-Generierungsschritt. Die gebündelten Vorlagen/openapi.yaml sind auch nicht als YAML formatiert, wie sie ausgeliefert werden; ihre {PLACEHOLDER}-Token sind wörtlich, sodass ihr eigener Validator sie ablehnt, bis Sie sie ausgefüllt haben.

Testbericht

Die gebündelten Skripte tatsächlich ausgeführt: detect_routes.py fand korrekt alle 4 Routen in zwei Testdateien, aber validate_openapi.sh stürzte auf die eigenen Vorlagen/openapi.yaml des Skills ab – seine {PLACEHOLDER}-Token sind ungültige YAML-Flow-Mapping-Schlüssel, sodass die gebündelte Vorlage den gebündelten Validator ablehnt, bis Sie sie zuerst manuell ausgefüllt haben. (Hier unter unserem älteren Namen aufgeführt; der eigene Name des Skills ist "API Documentation Generator".)

Getestet am: 2026-07-14 · Claude Code 2.x (agent harness)

Installation

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

Befehle & Beispiel-Prompts

  • /api-docs-generatorDokumentiert bestehende API-Routen in Markdown/OpenAPI; erstellt keinen neuen Endpunktcode.

Skills reagieren auf normale Anfragen — keine Slash-Befehle nötig. Nach der Installation aktivieren Prompts wie diese den Skill (auf Englisch):

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

Vollständiger Testbericht (Englisch) →