← 返回 Skills 市场
1067
总下载
0
收藏
5
当前安装
1
版本数
在 OpenClaw 中安装
/install sovereign-api-docs-generator
功能描述
Auto-generates comprehensive API docs from code. REST, GraphQL, WebSocket with examples and schemas.
使用说明 (SKILL.md)
\r \r
API Documentation Generator\r
\r You generate professional API documentation.\r \r For each endpoint generate:\r
- Method, path, description\r
- Authentication requirements\r
- Request headers, params, body schema with types\r
- Response status codes, body schema, error formats\r
- Examples in curl, JavaScript fetch, Python requests\r
- Rate limiting info\r \r Format as OpenAPI/Swagger-compatible markdown with tables for parameters and JSON examples for request/response bodies.\r
安全使用建议
This skill is instruction-only and safe from install-time execution, but it claims to auto-generate docs 'from code' without any mechanism to access your repository. Before installing or using it: (1) Ask the skill author how the agent is expected to obtain source code (upload, paste, repo clone, file path). (2) If you must paste code into the agent, avoid including secrets (API keys, credentials, private tokens) — test first with non-sensitive samples. (3) Prefer using it interactively (user-invoked) rather than allowing autonomous runs, since autonomous operation combined with unclear code-access behavior could prompt credential disclosure. (4) If you need automated repo scanning, prefer a tool that explicitly documents how it accesses repos and what permissions it requires.
功能分析
Type: OpenClaw Skill
Name: sovereign-api-docs-generator
Version: 1.0.0
The skill bundle is benign. The `_meta.json` provides standard metadata. The `SKILL.md` contains instructions for an AI agent to generate API documentation, specifying content and format. There are no instructions for the agent to perform any malicious actions, access sensitive data, execute arbitrary commands, or engage in prompt injection beyond its stated purpose of text generation. The generation of `curl`, `JavaScript fetch`, and `Python requests` examples is a standard part of API documentation and does not imply execution by the agent.
能力评估
Purpose & Capability
Name/description promise: 'Auto-generates ... from code'. What is delivered: an instruction-only SKILL.md that tells the agent how to format documentation but does not say how to obtain or analyze the user's codebase (no guidance to read files, clone repos, or accept a code path). This is an incoherence: a tool that claims to operate on code would normally require repository/file access or explicit instructions to prompt the user for code.
Instruction Scope
The SKILL.md gives a bounded and appropriate formatting checklist (endpoints, auth, schemas, examples) and specifies output format (OpenAPI/Swagger-compatible markdown). It does not instruct the agent to read arbitrary system files, environment variables, or to contact external endpoints. However, it is vague about where endpoint information comes from (implies code input but doesn't describe how to obtain it).
Install Mechanism
No install spec and no code files — lowest-risk instruction-only skill. Nothing will be written to disk or automatically installed by the skill itself.
Credentials
No environment variables, credentials, or config paths are requested. This is proportionate to the visible instructions, though it reinforces the mismatch: if the skill truly needed automated access to a repository it would typically request repo credentials or a path.
Persistence & Privilege
always is false and there are no persistence or privilege escalations declared. The skill does not request ongoing presence or system-level configuration changes.
如何使用
- 确保已安装 OpenClaw（本地或 Docker 部署）
- 在对话框中输入安装命令：
/install sovereign-api-docs-generator - 安装完成后，直接呼叫该 Skill 的名称或使用
/sovereign-api-docs-generator触发 - 根据 Skill 的参数说明提供必要输入，即可获得结构化输出
版本历史
v1.0.0
- Initial release of API Documentation Generator.
- Automatically generates comprehensive documentation for REST, GraphQL, and WebSocket APIs.
- Provides endpoint details: method, path, description, authentication, parameters, request/response schemas, and error formats.
- Includes example requests in curl, JavaScript fetch, and Python requests.
- Outputs OpenAPI/Swagger-compatible markdown with tables and JSON examples.
- Documents rate limiting information where applicable.
元数据
常见问题
API Documentation Generator 是什么？
Auto-generates comprehensive API docs from code. REST, GraphQL, WebSocket with examples and schemas. 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 1067 次。
如何安装 API Documentation Generator？
在 OpenClaw 或 Claude Code 对话框中运行命令「/install sovereign-api-docs-generator」即可一键安装，无需额外配置。
API Documentation Generator 是免费的吗？
是的，API Documentation Generator 完全免费（开源免费），可自由下载、安装和使用。
API Documentation Generator 支持哪些平台？
API Documentation Generator 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。
谁开发了 API Documentation Generator？
由 ryudi84（@ryudi84）开发并维护，当前版本 v1.0.0。
推荐 Skills