API Documenting
Převádí kód tras na referenční dokumentaci API s tabulkami parametrů, příklady curl, specifikacemi OpenAPI
Otestováno · Funguje
Co umí
Čte zdrojové soubory pro definice tras (Express, FastAPI, Flask, Spring, Gin) a generuje referenční dokumentaci API pomocí pevných šablon pro stránky endpointů a indexovou stránku, plus volitelnou specifikaci OpenAPI 3.0. Zahrnuje Python skript pro detekci tras a shell validátor pro generované specifikace. Spouští se, když uživatel požádá o dokumentaci API, generování dokumentace endpointů, vytvoření API reference nebo napsání specifikace OpenAPI/Swagger.
Testovací report
Klonoval jsem repozitář, nainstaloval do dočasného HOME (nikdy jsem se nedotkl skutečného ~/.claude) a potvrdil, že všech 8 souborů odkazovaných v těle SKILL.md existuje — PATTERNS.md, STANDARDS.md, EXAMPLES.md, templates/{endpoint,index,openapi}, scripts/{detect_routes.py,validate_openapi.sh} — tři z nich byly načteny s HTTP 200. Spustil jsem scripts/detect_routes.py proti 3trasovému souboru Express, který jsem napsal; správně vrátil GET /orders, POST /orders a DELETE /orders/:orderId s čísly souborů+řádků, takže pomocník je skutečný a ne dekorativní. Úkol: zdokumentovat stejný orders.js. Základní (46 řádků, 968 B) byly prozaické odrážky bez typů, bez sekce autentizace, bez curl, bez indexu; spuštění dovednosti (212 řádků, 3992 B) následovalo templates/index.md a poté templates/endpoint.md pro každou trasu a přidalo hlavičku base-URL/auth, souhrnnou tabulku endpointů, tabulku běžných stavových kódů, tři tabulky parametrů se sloupci Location/Type/Required (0 v základní verzi), tři spustitelné příklady požadavků/odpovědí curl (0 v základní verzi), případ 401, který základní verze vynechala, a řádek Notes, který jsem napsal pouze proto, že šablona vynutila sekci — ten 403 je kontrolován po existenci, takže platné ID vlastněné jiným uživatelem vrací 403, nikoli 404. Spouštěcí fráze posouzeny: MĚLO BY se spustit — „Vygenerujte API referenci pro trasy v src/api/“, „Napište specifikaci OpenAPI 3.0 pro mou aplikaci FastAPI“, „Zdokumentujte všechny endpointy v tomto Express routeru“ (načteny všechny tři); NEMĚLO BY se spustit — „Navrhněte REST API pro rezervační systém, jaké endpointy bych měl mít?“ (návrh API, ne dokumentace existujícího kódu) a „Napište README pro tento CLI nástroj“ (dokumentace, ale žádné endpointy); obojí správně odmítnuto, 5/5. Žádné bezpečnostní nedostatky: žádné curl|sh, žádné base64, žádné síťové volání, žádný tajný přístup; validate_openapi.sh se spouští pouze na swagger-cli/npx/spectral, pokud jsou již přítomny. Dokumentace snížena o jeden bod, protože dovednost se nachází uvnitř projektu lekce kurzu bez vlastního samostatného README — okolní README je výukový materiál o progresivním odhalování, nikoli dokumentace použití.
Testováno: 2026-07-21 · Claude Code 2.x (agent harness)
Instalace
git clone --depth 1 https://github.com/huangjia2019/claude-code-engineering.git /tmp/api-documenting-src mkdir -p ~/.claude/skills cp -R /tmp/api-documenting-src/04-Skills/projects/02-progressive-skill/.claude/skills/api-documenting ~/.claude/skills/api-documenting # No dependencies for the documentation workflow itself. # Optional helper: python3 ~/.claude/skills/api-documenting/scripts/detect_routes.py <source_dir> -> JSON list of routes (stdlib only, no pip installs) # Optional helper: bash ~/.claude/skills/api-documenting/scripts/validate_openapi.sh <spec.yaml> -> needs swagger-cli / npx / spectral, else falls back to a YAML syntax check # The repo is a Claude Code course; this skill lives in lesson project 04-Skills/projects/02-progressive-skill. No plugin marketplace entry.
Příkazy a ukázkové prompty
/api-documentingPřevádí kód tras na referenční dokumentaci API s tabulkami parametrů, příklady curl, specifikacemi OpenAPI
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 API reference docs for this serviceCreate an OpenAPI spec for these endpointsDocument this API's request and response formats