Vai al contenuto
TakoAPI
Torna alle skill

sovereign-api-docs-generator

di ryudi84

Web & Frontend Development
571Download riportati da clawskills.sh
0Visualizzazioni
0 likeAccedi per mettere like a questa skill
—Non ancora valutato
La tua valutazione

Sintesi

Auto-generates comprehensive API docs from code.

Descrizione

Cosa fa questa skill

Generates API documentation from code descriptions, covering REST, GraphQL, and WebSocket endpoints. Produces OpenAPI/Swagger-compatible markdown with parameter tables, JSON request/response examples, and code samples in curl, JavaScript fetch, and Python requests.

Covers REST, GraphQL, and WebSocket in a single pass and outputs OpenAPI-compatible format, removing the need to manually author specs across multiple tools.

Quando usarla

  • Documenting a new REST API before releasing it to external developers
  • Generating curl and fetch examples for undocumented endpoints
  • Creating OpenAPI specs from a legacy codebase
  • Adding request and response schemas to a GraphQL API
  • Producing auth and rate limit docs for an internal service

Esempio di workflow

INPUT

User asks: Document the POST /users endpoint with JWT auth and a JSON body

AGENT
  1. 1

    Identifies method (POST), path (/users), and writes a plain-language description

  2. 2

    Documents authentication requirement (JWT Bearer token in Authorization header)

  3. 3

    Generates request body schema with field names, types, and required flags

  4. 4

    Lists response status codes (201, 400, 401) with body schemas and error formats

  5. 5

    Produces code examples in curl, JavaScript fetch, and Python requests

OUTPUT

OpenAPI-compatible markdown block with a parameters table, JSON request/response examples, and multi-language code snippets

Installazione

clawhub install ryudi84/sovereign-api-docs-generator

Esegui il comando CLI oppure incolla il prompt in Claude Code, Cursor, Codex o nell'agente di coding che usi.

Link