API Documentation Generator

Dokumentuje existující API trasy do markdown/OpenAPI; neskriptuje nový kód koncových bodů.

od huangjia2019 · huangjia2019/claude-code-engineering

Funguje s nastavením ★ 8.0/10

API Documentation Generator — Dokumentuje existující API trasy do markdown/OpenAPI; neskriptuje nový kód koncových bodů.

Co umí

Prohledává existující obslužné rutiny tras (Express, FastAPI, Spring Boot, Go) pro metodu, cestu, parametry a ověření, poté vyplní přiloženou šablonu endpoint.md do dokumentace markdown nebo specifikace OpenAPI 3.0; dodává skutečný skener detect_routes.py a kontrolor validate_openapi.sh, které oba běží samostatně. Jeho vlastní frontmatter přehání: uvádí 'použijte, když uživatel chce vytvořit nové koncové body API, generovat obslužné rutiny tras, skriptovat REST API', ale tělo pouze dokumentuje koncové body, které již existují — neexistuje žádný krok generování kódu. Přiložené šablony/openapi.yaml také nejsou při dodání platným YAML; jeho zástupné tokeny {PLACEHOLDER} jsou doslovné, takže jeho vlastní validátor je odmítá, dokud je nevyplníte.

Testovací report

Spustil jsem přiložené skripty reálně: detect_routes.py správně našel všechny 4 trasy ve dvou testovacích souborech, ale validate_openapi.sh zakolísal na vlastních šablonách dovednosti/openapi.yaml — jeho zástupné tokeny {PLACEHOLDER} jsou neplatné klíče mapování toku YAML, takže přiložená šablona selže u přiloženého validátoru, dokud ji nejprve ručně nevyplníte. (Zde uvedeno pod naším starším názvem; vlastní název dovednosti je "API Documentation Generator".)

Testováno: 2026-07-14 · Claude Code 2.x (agent harness)

Instalace

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

Příkazy a ukázkové prompty

  • /api-docs-generatorDokumentuje existující API trasy do markdown/OpenAPI; neskriptuje nový kód koncových bodů.

Skilly se spouštějí běžnými požadavky — žádné příkazy k zapamatování. Po instalaci ho aktivují prompty jako tyto (anglicky):

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