← Back to Skills Marketplace
139
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install skylv-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 instruction-only and appears coherent with its purpose. Before using it, avoid pasting secrets or private credentials into prompts or sample code you ask it to rewrite; review any generated OpenAPI/Swagger files and example code for accuracy and security (authentication handling, rate limits, and exposing sensitive fields). If you plan to integrate generated specs into CI/CD or production systems, validate them with your existing tools and linters.
Capability Analysis
Type: OpenClaw Skill
Name: skylv-api-documentation
Version: 1.0.0
The skill bundle contains only metadata and documentation for an API documentation assistant. There is no executable code, and the instructions in SKILL.md are limited to standard API documentation tasks such as generating Swagger configurations and example code, with no evidence of malicious intent or high-risk behaviors.
Capability Assessment
Purpose & Capability
Name, description, and SKILL.md all describe generating API docs, Swagger/OpenAPI, examples, and versioning; there are no unrelated environment variables, binaries, or install steps requested.
Instruction Scope
SKILL.md contains only usage prompts and examples for documentation tasks and does not instruct reading files, accessing system paths, calling external endpoints, or exfiltrating data.
Install Mechanism
No install specification or code files are present (instruction-only), so nothing will be written to disk or fetched during install.
Credentials
The skill requires no environment variables, credentials, or config paths — consistent with a documentation helper.
Persistence & Privilege
always is false and the skill is user-invocable (normal). Autonomous invocation is allowed by default but, combined with the skill's minimal scope, does not create additional concern.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install skylv-api-documentation - After installation, invoke the skill by name or use
/skylv-api-documentation - Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
Initial-release
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 139 downloads so far.
How do I install Api Documentation?
Run "/install skylv-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