← Back to Skills Marketplace
115
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install openclaw-api-documentation
Description
API文档助手。生成API文档、编写Swagger/OpenAPI、示例代码。使用场景：(1) 文档生成，(2) Swagger配置，(3) 示例代码，(4) 版本管理。
README (SKILL.md)
API Documentation — API文档助手
功能说明
生成和管理API文档。
使用方法
1. 文档生成
用户: 根据这个代码生成API文档
2. Swagger配置
用户: 写一个Swagger/OpenAPI配置
3. 示例代码
用户: 生成各语言的API调用示例
4. 版本管理
用户: 如何管理API版本？
Usage Guidance
This skill is low-risk and internally consistent: it only provides textual instructions for generating API docs and asks for nothing sensitive. Before using, confirm you trust the skill source (unknown here), and avoid pasting secrets, private keys, or private repository code into prompts — the skill will produce output based on whatever you provide. If you later add integrations (repo access, CI hooks, automated publishing), require explicit, service-specific credentials and review those additions separately.
Capability Assessment
Purpose & Capability
Name and description (generate API docs, Swagger/OpenAPI, sample code, versioning) match the SKILL.md content; there are no unrelated requirements or capabilities requested.
Instruction Scope
SKILL.md contains only short examples of user prompts and high-level instructions for doc generation and versioning. It does not instruct the agent to read system files, access environment variables, call external endpoints, or perform actions outside the stated scope.
Install Mechanism
No install spec and no code files are present (instruction-only). Nothing will be written to disk or downloaded by the skill itself.
Credentials
The skill declares no required environment variables, credentials, or config paths; this is proportionate for a documentation-generation helper.
Persistence & Privilege
always is false and the skill does not request any elevated or persistent privileges. Autonomous invocation is allowed by platform default but is not combined with other risky indicators.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install openclaw-api-documentation - After installation, invoke the skill by name or use
/openclaw-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.
- Generate and manage API documentation based on code or requirements.
- Create Swagger/OpenAPI configurations for your APIs.
- Provide example code snippets in multiple languages for API usage.
- Offer guidance on API version management strategies.
- Usable for documentation generation, Swagger setup, code examples, and versioning support.
Metadata
Frequently Asked Questions
What is Api Documentation?
API文档助手。生成API文档、编写Swagger/OpenAPI、示例代码。使用场景：(1) 文档生成，(2) Swagger配置，(3) 示例代码，(4) 版本管理。 It is an AI Agent Skill for Claude Code / OpenClaw, with 115 downloads so far.
How do I install Api Documentation?
Run "/install openclaw-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 SKY-lv (@sky-lv); the current version is v1.0.0.
More Skills