API Doc Generator

Přemění zdrojový kód na strukturovanou API dokumentaci s šablonou vynucující úplnost

od JackyST0 · JackyST0/awesome-agent-skills

Otestováno · Funguje ★ 8.8/10

API Doc Generator — Přemění zdrojový kód na strukturovanou API dokumentaci s šablonou vynucující úplnost

Co umí

Generuje API reference documentation z source code (REST, GraphQL, RPC) using bundled Handlebars-style template, které enforces endpoint overview, path/query params, request/response bodies, authentication a error responses. Spouští se, když požádáte o generate API docs, create interface documentation nebo produce OpenAPI/Swagger specs. Bilingual (English/Chinese) instructions.

Testovací report

Předložil jsem mu fresh 3-endpoint FastAPI app s Bearer auth a pagination; bundled template forces slots, které freehand pass rutinně drops — dedicated Authentication table, query-parameter default values (limit=10, offset=0) a per-endpoint error responses (404 a 401), plus global error-codes a rate-limit section. Template shipped v templates/api-doc.md je actually richer než SKILL.md body advertises. Clean, no scripts nebo network calls.

Testováno: 2026-07-17 · Claude Code 2.x (agent harness)

Instalace

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

Příkazy a ukázkové prompty

  • /api-doc-generatorPřemění zdrojový kód na strukturovanou API dokumentaci s šablonou vynucující úplnost

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