← 返回 Skills 市场
115
总下载
0
收藏
0
当前安装
1
版本数
在 OpenClaw 中安装
/install openclaw-api-documentation
功能描述
API文档助手。生成API文档、编写Swagger/OpenAPI、示例代码。使用场景：(1) 文档生成，(2) Swagger配置，(3) 示例代码，(4) 版本管理。
使用说明 (SKILL.md)
API Documentation — API文档助手
功能说明
生成和管理API文档。
使用方法
1. 文档生成
用户: 根据这个代码生成API文档
2. Swagger配置
用户: 写一个Swagger/OpenAPI配置
3. 示例代码
用户: 生成各语言的API调用示例
4. 版本管理
用户: 如何管理API版本？
安全使用建议
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.
能力评估
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.
如何使用
- 确保已安装 OpenClaw（本地或 Docker 部署）
- 在对话框中输入安装命令：
/install openclaw-api-documentation - 安装完成后，直接呼叫该 Skill 的名称或使用
/openclaw-api-documentation触发 - 根据 Skill 的参数说明提供必要输入，即可获得结构化输出
版本历史
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.
元数据
常见问题
Api Documentation 是什么？
API文档助手。生成API文档、编写Swagger/OpenAPI、示例代码。使用场景：(1) 文档生成，(2) Swagger配置，(3) 示例代码，(4) 版本管理。 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 115 次。
如何安装 Api Documentation？
在 OpenClaw 或 Claude Code 对话框中运行命令「/install openclaw-api-documentation」即可一键安装，无需额外配置。
Api Documentation 是免费的吗？
是的，Api Documentation 完全免费，采用 MIT-0 许可证，可自由下载、安装和使用。
Api Documentation 支持哪些平台？
Api Documentation 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。
谁开发了 Api Documentation？
由 SKY-lv（@sky-lv）开发并维护，当前版本 v1.0.0。
推荐 Skills