कंटेंट पर जाएँ
TakoAPI
स्किल्स पर वापस

sovereign-api-docs-generator

ryudi84 द्वारा

Web & Frontend Development
571clawskills.sh द्वारा बताए गए डाउनलोड
0व्यूज़
0 लाइकइस स्किल को लाइक करने के लिए साइन इन करें
—अभी तक कोई रेटिंग नहीं
आपकी रेटिंग

संक्षिप्त

Auto-generates comprehensive API docs from code.

विवरण

यह स्किल क्या करती है

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.

इसे कब इस्तेमाल करें

  • 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

उदाहरण वर्कफ़्लो

इनपुट

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

एजेंट
  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

आउटपुट

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

इंस्टॉलेशन

clawhub install ryudi84/sovereign-api-docs-generator

CLI कमांड चलाएँ, या प्रॉम्प्ट को Claude Code, Cursor, Codex या जो भी कोडिंग एजेंट आप इस्तेमाल करते हैं उसमें पेस्ट करें।

लिंक