← Back to Skills Marketplace
Api Documentation
by
1477009639zw-blip
· GitHub ↗
· v1.0.0
· MIT-0
251
Downloads
0
Stars
1
Active Installs
1
Versions
Install in OpenClaw
/install api-documentation
Description
Creates comprehensive API documentation including OpenAPI specs, reference guides, tutorials, and Postman collections. Makes your API developer-friendly.
README (SKILL.md)
API Documentation Service
What You Get
OpenAPI 3.0 Specification
- Complete paths and operations
- Request/response schemas
- Authentication documentation
- Error codes and descriptions
- Examples for every endpoint
Developer Guide
- Getting started tutorial
- Authentication setup
- Code examples in 5+ languages
- SDK installation guides
- Rate limiting documentation
Reference Manual
- Alphabetical endpoint reference
- Request/response field descriptions
- Data types and formats
- Pagination and filtering
Postman Collection
- Ready-to-use requests
- Environment variables
- Test scripts
- Auto-generated from OpenAPI
Pricing
| Type | Endpoints | Turnaround | Price |
|---|---|---|---|
| Simple API | 5-10 | 2 days | $100 |
| Medium API | 10-30 | 4 days | $300 |
| Complex API | 30+ | 7 days | $800 |
Tools
- Swagger/OpenAPI 3.0
- Stoplight Elements
- Redoc
- Postman
- Docusaurus
Usage Guidance
This skill appears coherent and low-risk as distributed (no install, no credentials). Before using it, be prepared to provide an API specification or examples — but do not paste live secrets or production API keys into the chat. Prefer sanitized example endpoints or short-lived credentials. Verify that the environment where the agent runs has the tooling you expect (python3 and any documentation tools), and clarify with the agent exactly what inputs it needs and how outputs will be returned. If you must share credentials, use temporary keys and rotate them afterward. Finally, treat the pricing table and any quoted turnaround as an external commercial offer — the skill itself does not perform billing or payment.
Capability Analysis
Type: OpenClaw Skill
Name: api-documentation
Version: 1.0.0
The skill bundle consists solely of metadata and descriptive documentation (SKILL.md) for an API documentation service. It contains no executable code, scripts, or instructions that would cause the agent to perform any actions, malicious or otherwise.
Capability Assessment
Purpose & Capability
Name, description, and declared requirement (python3) are consistent with a documentation-generation task. The SKILL.md lists typical tooling (OpenAPI, Postman, Redoc) that match the stated outputs; nothing requested is unrelated to producing API docs.
Instruction Scope
The SKILL.md is high-level and prescriptive about deliverables (OpenAPI, guides, Postman collection) but contains no concrete runtime commands. That makes the skill vague: at runtime the agent may request API specs, source code, or credentials from the user. This is not inherently malicious, but it grants the agent broad discretion and raises privacy/secret-sharing considerations.
Install Mechanism
No install spec and no code files are present (instruction-only), so nothing will be downloaded or written by the skill itself. This is the lowest-risk install posture.
Credentials
The skill declares no environment variables, no config paths, and only a benign requirement of python3. There are no disproportionate credential requests in the manifest. Note: the agent may later ask the user for API credentials or access to private specs to perform the job — those would be outside the manifest.
Persistence & Privilege
always is false and the skill is user-invocable; it does not request persistent presence or elevated agent-wide privileges.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install api-documentation - After installation, invoke the skill by name or use
/api-documentation - Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
- Initial release of "api-documentation" skill.
- Generates complete API documentation including OpenAPI 3.0 specs, reference guides, developer tutorials, and Postman collections.
- Covers authentication, error codes, code samples in 5+ languages, pagination, filtering, and more.
- Offers pricing tiers for APIs of varying complexity.
- Utilizes tools such as Swagger/OpenAPI, Redoc, Postman, and Docusaurus.
Metadata
Frequently Asked Questions
What is Api Documentation?
Creates comprehensive API documentation including OpenAPI specs, reference guides, tutorials, and Postman collections. Makes your API developer-friendly. It is an AI Agent Skill for Claude Code / OpenClaw, with 251 downloads so far.
How do I install Api Documentation?
Run "/install api-documentation" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Api Documentation free?
Yes, Api Documentation is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Api Documentation support?
Api Documentation is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Api Documentation?
It is built and maintained by 1477009639zw-blip (@1477009639zw-blip); the current version is v1.0.0.
More Skills