Lewati ke konten
TakoAPI
Kembali ke skill

sovereign-api-docs-generator

oleh ryudi84

Web & Frontend Development
571Unduhan dilaporkan oleh clawskills.sh
0Tayangan
0 sukaMasuk untuk menyukai skill ini
—Belum ada penilaian
Penilaian Anda

Ringkasan

Auto-generates comprehensive API docs from code.

Deskripsi

Apa yang Dilakukan Skill Ini

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.

Kapan Menggunakannya

  • 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

Contoh Alur Kerja

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

Instalasi

clawhub install ryudi84/sovereign-api-docs-generator

Jalankan perintah CLI-nya, atau tempel prompt ke Claude Code, Cursor, Codex, atau coding agent apa pun yang Anda pakai.

Tautan