跳到正文
TakoAPI
返回技能列表

sovereign-api-docs-generator

由 ryudi84 提供

Web & Frontend Development
571下载量由 clawskills.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 或你在用的任意编程智能体里。

链接