← Back to Skills Marketplace
1067
Downloads
0
Stars
5
Active Installs
1
Versions
Install in OpenClaw
/install sovereign-api-docs-generator
Description
Auto-generates comprehensive API docs from code. REST, GraphQL, WebSocket with examples and schemas.
README (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
Usage Guidance
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.
Capability Analysis
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.
Capability Assessment
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.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install sovereign-api-docs-generator - After installation, invoke the skill by name or use
/sovereign-api-docs-generator - Provide required inputs per the skill's parameter spec and get structured output
Version History
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.
Metadata
Frequently Asked Questions
What is API Documentation Generator?
Auto-generates comprehensive API docs from code. REST, GraphQL, WebSocket with examples and schemas. It is an AI Agent Skill for Claude Code / OpenClaw, with 1067 downloads so far.
How do I install API Documentation Generator?
Run "/install sovereign-api-docs-generator" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is API Documentation Generator free?
Yes, API Documentation Generator is completely free (open-source). You can download, install and use it at no cost.
Which platforms does API Documentation Generator support?
API Documentation Generator is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created API Documentation Generator?
It is built and maintained by ryudi84 (@ryudi84); the current version is v1.0.0.
More Skills