API Documenting
Förvandlar ruttkod till API-referensdokumentation med parametertabeller, curl-exempel, OpenAPI-specifikationer
Testad · Fungerar
Vad den gör
Läser källfiler för ruttdefinitioner (Express, FastAPI, Flask, Spring, Gin) och genererar API-referensdokumentation med fasta mallar för endpoint-sidorna och indexsidan, plus en valfri OpenAPI 3.0-specifikation. Inkluderar ett Python-skript för ruttupptäckt och en shell-validator för genererade specifikationer. Utlöses när användaren ber att dokumentera API:er, generera endpoint-dokumentation, producera en API-referens, eller skriva en OpenAPI/Swagger-specifikation.
Testrapport
Klonade repot, installerade i en temporär HOME (rörde aldrig den riktiga ~/.claude), och bekräftade att alla 8 filer som SKILL.md-kroppen refererar existerar — PATTERNS.md, STANDARDS.md, EXAMPLES.md, templates/{endpoint,index,openapi}, scripts/{detect_routes.py,validate_openapi.sh} — hämtade tre på HTTP 200. Körde scripts/detect_routes.py mot en 3-rutt Express-fil jag skrev; den returnerade korrekt GET /orders, POST /orders och DELETE /orders/:orderId med fil+radnummer, så hjälparen är verklig och inte dekorativ. Uppgift: dokumentera samma orders.js. Baslinjen (46 rader, 968 B) var prosakulor utan typer, ingen auth-sektion, ingen curl, inget index; färdighetskörningen (212 rader, 3992 B) följde templates/index.md sedan templates/endpoint.md per rutt och lade till en bas-URL/auth-header, en endpoint-sammanfattningstabell, en tabell för vanliga svarskoder, tre parametertabeller med Location/Type/Required-kolumner (0 i baslinjen), tre körbara curl-request/response-exempel (0 i baslinjen), 401-fallet som baslinjen utelämnade, och en Notes-rad jag bara skrev för att mallen tvingade fram sektionen — att 403 kontrolleras efter existens, så ett giltigt ID som ägs av en annan användare returnerar 403 inte 404. Utlösningsfraser bedömda: SKULLE utlösas — "Generera en API-referens för rutterna i src/api/", "Skriv en OpenAPI 3.0-spec för min FastAPI-app", "Dokumentera alla endpoints i denna Express-router" (laddade alla tre); SKULLE INTE — "Designa ett REST API för ett bokningssystem, vilka endpoints ska jag ha?" (API-design, inte dokumentera befintlig kod) och "Skriv en README för detta CLI-verktyg" (dokumentation men inga endpoints); båda avböjdes korrekt, 5/5. Inga säkerhetsbrister: ingen curl|sh, ingen base64, inga nätverksanrop, ingen hemlig åtkomst; validate_openapi.sh kör endast swagger-cli/npx/spectral om de redan finns. Dokumentation avdragen en poäng eftersom färdigheten ligger inom ett kurslektionsprojekt utan egen fristående README — den omgivande README är undervisningsmaterial om progressiv avslöjande, inte användningsdokumentation.
Testad: 2026-07-21 · Claude Code 2.x (agent harness)
Installation
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.
Kommandon och exempelprompter
/api-documentingFörvandlar ruttkod till API-referensdokumentation med parametertabeller, curl-exempel, OpenAPI-specifikationer
Skills triggas av vanliga förfrågningar — inga kommandon att memorera. Efter installationen aktiverar prompter som dessa skillen (på engelska):
Generate API reference docs for this serviceCreate an OpenAPI spec for these endpointsDocument this API's request and response formats