← 返回 Skills 市场
sydpz

Api Design

作者 BingWang · GitHub ↗ · v1.0.0 · MIT-0
cross-platform ✓ 安全检测通过
139
总下载
0
收藏
0
当前安装
1
版本数
在 OpenClaw 中安装
/install openapi-design
功能描述
API design specification and best practices skill. Use when: designing new APIs, reviewing existing APIs, generating API documentation, standardizing interfa...
安全使用建议
This skill is a local API design guide and appears coherent and low-risk. Before installing: (1) confirm you trust the skill source (homepage unknown); (2) avoid pasting real secrets or production tokens into prompts or example templates (the docs include sample tokens/passwords for illustration); (3) if your agent environment can run shell/CLI commands, be explicit about whether you want the agent to execute any npm/docker/curl examples from the docs — the skill itself does not automatically install or run those tools. If you need networked behavior or credential use, request that from a skill that explicitly declares those needs.
功能分析
Type: OpenClaw Skill Name: openapi-design Version: 1.0.0 The skill bundle is a comprehensive collection of documentation, checklists, and templates for API design best practices (REST, OpenAPI 3.0). It contains no executable code, suspicious network calls, or instructions that could lead to data exfiltration or unauthorized access. All files, including SKILL.md and the references directory, are strictly aligned with the stated purpose of providing guidance on naming conventions, security best practices, and documentation generation.
能力评估
Purpose & Capability
Name and description (API design, review, documentation) match the packaged files: design principles, templates, review checklists, and docs. There are no unrelated requirements (no binaries, env vars, or config paths).
Instruction Scope
SKILL.md instructs the agent to read local reference files and use templates to produce docs/review output — this is appropriate. The reference docs contain example CLI commands (npm, docker, curl) and sample tokens/passwords in examples; those are illustrative only. Recommend caution: do not paste real secrets into examples or prompt the agent to run those commands automatically.
Install Mechanism
No install spec and no code files to write or execute. Lowest-risk category (instruction-only).
Credentials
The skill requires no environment variables, credentials, or config paths. All content is local documentation and templates, so requested privileges are proportional.
Persistence & Privilege
always is false and there is no install-time modification or persistent agent configuration. The skill is user-invocable and the platform default allows autonomous invocation, but that default is not combined here with any broad privileges or credentials.
如何使用
  1. 确保已安装 OpenClaw(本地或 Docker 部署)
  2. 在对话框中输入安装命令:/install openapi-design
  3. 安装完成后,直接呼叫该 Skill 的名称或使用 /openapi-design 触发
  4. 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
版本历史
v1.0.0
Initial release of the API Design skill. - Provides API design principles, naming conventions, HTTP status codes, error response formats, and versioning strategies. - Includes OpenAPI documentation templates and review checklists for both design and audit scenarios. - Supports both English and Chinese triggers for flexible usage. - Offers a structured guide and references for designing, reviewing, and standardizing APIs.
元数据
Slug openapi-design
版本 1.0.0
许可证 MIT-0
累计安装 0
当前安装数 0
历史版本数 1
常见问题

Api Design 是什么?

API design specification and best practices skill. Use when: designing new APIs, reviewing existing APIs, generating API documentation, standardizing interfa... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 139 次。

如何安装 Api Design?

在 OpenClaw 或 Claude Code 对话框中运行命令「/install openapi-design」即可一键安装,无需额外配置。

Api Design 是免费的吗?

是的,Api Design 完全免费,采用 MIT-0 许可证,可自由下载、安装和使用。

Api Design 支持哪些平台?

Api Design 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。

谁开发了 Api Design?

由 BingWang(@sydpz)开发并维护,当前版本 v1.0.0。

💬 留言讨论