API Documentation Generator

Dokumenterar befintliga API-rutter till markdown/OpenAPI; skapar inte ny endpoint-kod.

av huangjia2019 · huangjia2019/claude-code-engineering

Fungerar med konfiguration ★ 8.0/10

API Documentation Generator — Dokumenterar befintliga API-rutter till markdown/OpenAPI; skapar inte ny endpoint-kod.

Vad den gör

Skannar befintliga rutt-hanterare (Express, FastAPI, Spring Boot, Go) efter metod, sökväg, parametrar och auth, fyller sedan en medföljande endpoint.md-mall till markdown-dokumentation eller en OpenAPI 3.0-spec; levererar en riktig detect_routes.py-skanner och en validate_openapi.sh-kontroll som båda körs fristående. Dess egen frontmatter översäljer: den säger 'använd när användaren vill skapa nya API-endpoints, generera rutt-hanterare, skapa REST API:er', men kroppen dokumenterar bara endpoints som redan finns – det finns inget kodgenereringssteg. De medföljande mallarna/openapi.yaml är inte heller giltig YAML som levererad; dess {PLACEHOLDER}-tokens är bokstavliga, så dess egen validator avvisar den tills du fyller i dem.

Testrapport

Körde de medföljande skripten på riktigt: detect_routes.py hittade korrekt alla 4 rutter i två testfiler, men validate_openapi.sh kvävdes på färdighetens egna mallar/openapi.yaml – dess {PLACEHOLDER}-tokens är ogiltiga YAML flow-mapping-nycklar, så den medföljande mallen misslyckas med den medföljande validatorn tills du fyller i den manuellt först. (Listad här under vårt äldre namn; färdighetens eget namn är "API Documentation Generator".)

Testad: 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

Kommandon och exempelprompter

  • /api-docs-generatorDokumenterar befintliga API-rutter till markdown/OpenAPI; skapar inte ny endpoint-kod.

Skills triggas av vanliga förfrågningar — inga kommandon att memorera. Efter installationen aktiverar prompter som dessa skillen (på engelska):

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