SkillProof tested Claude skills

API Documentation Generator

Genererer API-dokumentasjon til markdown/OpenAPI; genererer ikke ny endepunktskode.

av huangjia2019 · huangjia2019/claude-code-engineering

Krever oppsett ★ 8.0/10

API Documentation Generator — Genererer API-dokumentasjon til markdown/OpenAPI; genererer ikke ny endepunktskode.

Hva den gjør

Skanner eksisterende rutebehandlere (Express, FastAPI, Spring Boot, Go) for metode, sti, parametere og autentisering, fyller deretter en bundlet endepunkt.md-mal om til markdown-dokumentasjon eller en OpenAPI 3.0-spesifikasjon; leverer en ekte detect_routes.py-skanner og en validate_openapi.sh-kontrollør som begge kjører frittstående. Sin egen frontmatter overselger: den sier 'bruk når brukeren ønsker å opprette nye API-endepunkter, generere rutebehandlere, lage REST API-er', men kroppen dokumenterer bare endepunkter som allerede eksisterer — det er ingen kodegenereringstrinn. De bundlete malene/openapi.yaml er heller ikke gyldig YAML slik den leveres; dens {PLACEHOLDER}-tokens er bokstavelige, så dens egen validator avviser den før du fyller dem inn.

Testrapport

Kjørte de bundlete skriptene i praksis: detect_routes.py fant riktig alle 4 rutene på tvers av to testfiler, men validate_openapi.sh feilet på ferdighetens egen maler/openapi.yaml — dens {PLACEHOLDER}-tokens er ugyldige YAML flow-mapping-nøkler, så den bundlete malen feiler den bundlete validatoren før du fyller den manuelt først. (Listet her under vårt eldre navn; ferdighetens eget navn er "API Documentation Generator".)

Testet på: 2026-07-14 · Claude Code 2.x (agent harness)

Installer

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

Kommandoer og eksempelprompter

  • /api-docs-generatorGenererer API-dokumentasjon til markdown/OpenAPI; genererer ikke ny endepunktskode.

Skills utløses av vanlige forespørsler — ingen kommandoer å huske. Etter installasjonen aktiverer prompter som disse skillen (på engelsk):

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

Full rapport →