API Doc Generator

Zet broncode om in gestructureerde API docs met een volledigheid-afdwingende template

Door JackyST0 · JackyST0/awesome-agent-skills

Getest · Werkt ★ 8.8/10

API Doc Generator — Zet broncode om in gestructureerde API docs met een volledigheid-afdwingende template

Wat het doet

Genereert API referentiedocumentatie uit broncode (REST, GraphQL, RPC) met behulp van een gebundelde Handlebars-stijl template die endpoint overview, path/query params, request/response bodies, authenticatie en error responses afdwingt. Activeert wanneer gevraagd wordt om API docs te genereren, interface documentatie te creëren, of OpenAPI/Swagger specs te produceren. Tweetalige (Engels/Chinees) instructies.

Testrapport

Een verse 3-endpoint FastAPI app met Bearer auth en paginering gevoed; de gebundelde template dwingt slots af die een vrije-hand pass routinematig laat vallen — een dedicated Authentication table, query-parameter default values (limit=10, offset=0), en per-endpoint error responses (404 en 401), plus een globale error-codes en rate-limit sectie. De template die in templates/api-doc.md wordt geleverd, is eigenlijk rijker dan de SKILL.md body adverteert. Schoon, geen scripts of netwerkoproepen.

Getest op: 2026-07-17 · Claude Code 2.x (agent harness)

Installatie

git clone https://github.com/JackyST0/awesome-agent-skills.git
mkdir -p ~/.claude/skills
cd awesome-agent-skills && cp -r examples/api-doc-generator ~/.claude/skills/api-doc-generator

Commando's en voorbeeldprompts

  • /api-doc-generatorZet broncode om in gestructureerde API docs met een volledigheid-afdwingende template

Skills reageren op gewone verzoeken — geen commando's om te onthouden. Na installatie activeren prompts zoals deze de skill (in het Engels):

  • generate API docs for my FastAPI endpoints with auth and errors
  • write documentation for these REST routes including params
  • create an OpenAPI-style reference from my GraphQL schema