← Back to Skills Marketplace
1999
Downloads
0
Stars
33
Active Installs
1
Versions
Install in OpenClaw
/install api-design
Description
REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting for production APIs.
Usage Guidance
Safe to install as an API design reference skill. Treat the token and API key snippets as placeholders only, and still review any generated API code for authentication, authorization, validation, and error-handling correctness before using it in production.
Capability Analysis
Type: OpenClaw Skill
Name: api-design
Version: 1.0.0
The skill bundle contains metadata and a comprehensive markdown document detailing REST API design patterns. All content is informational and educational, providing guidelines and code examples for API implementation. There are no instructions for the AI agent to perform any harmful actions, access sensitive data, or execute external commands. The code snippets are illustrative of server-side API logic, not agent commands, and there is no evidence of prompt injection attempts or malicious intent in SKILL.md.
Capability Assessment
Purpose & Capability
The skill purpose and artifact content align: it provides REST API design guidance on resource naming, methods, status codes, pagination, filtering, authentication patterns, versioning, rate limits, and implementation examples.
Instruction Scope
The instructions are reference material for API design and do not direct the agent to run commands, access accounts, collect secrets, change settings, or ignore user/system instructions.
Install Mechanism
The artifact contains a single non-executable SKILL.md file; no scripts, dependencies, binaries, install hooks, or external downloads are present.
Credentials
No local files, credentials, browser profiles, network endpoints, broad indexing, or privileged environment access are requested.
Persistence & Privilege
No persistence, background workers, privilege escalation, credential storage, or autonomous behavior is present.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install api-design - After installation, invoke the skill by name or use
/api-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, providing practical REST API design patterns and conventions for production use.
- Covers resource naming, HTTP methods, and appropriate status codes.
- Includes best practices for pagination (offset and cursor-based), filtering, sorting, and error response formats.
- Describes guidelines for authentication, authorization, versioning, and rate limiting strategies.
- Supplies code examples and implementation notes for common API scenarios.
Metadata
Frequently Asked Questions
What is Api Design?
REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting for production APIs. It is an AI Agent Skill for Claude Code / OpenClaw, with 1999 downloads so far.
How do I install Api Design?
Run "/install api-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 (open-source). 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 shateily (@shateily); the current version is v1.0.0.
More Skills