← Back to Skills Marketplace
139
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install openapi-design
Description
API design specification and best practices skill. Use when: designing new APIs, reviewing existing APIs, generating API documentation, standardizing interfa...
Usage Guidance
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.
Capability Analysis
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.
Capability Assessment
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.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install openapi-design - After installation, invoke the skill by name or use
/openapi-design - Provide required inputs per the skill's parameter spec and get structured output
Version History
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.
Metadata
Frequently Asked Questions
What is Api Design?
API design specification and best practices skill. Use when: designing new APIs, reviewing existing APIs, generating API documentation, standardizing interfa... It is an AI Agent Skill for Claude Code / OpenClaw, with 139 downloads so far.
How do I install Api Design?
Run "/install openapi-design" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Api Design free?
Yes, Api Design is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Api Design support?
Api Design is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Api Design?
It is built and maintained by BingWang (@sydpz); the current version is v1.0.0.
More Skills