A senior API architect skill for designing professional REST and GraphQL interfaces with OpenAPI 3.1 compliance.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install toby-api-designer
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install toby-api-designer using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is API Designer?
The API Designer is a specialized architect skill designed to help developers build intuitive and scalable API architectures. By integrating this into your Openclaw Skills collection, you gain access to expert-level guidance on resource modeling, HTTP semantics, and contract-first development. This skill synthesizes over a decade of industry expertise to ensure that your API designs remain performant, secure, and highly maintainable.
Whether you are drafting internal microservices or public-facing platforms, the API Designer prioritizes developer experience (DX). It automates the complex logic of resource relationship mapping and enforces industry standards like RFC 7807 for error handling. Utilizing this within your Openclaw Skills workflow ensures that every endpoint is architected for long-term growth and compliance.
API Designer Use Cases
- Designing new REST or GraphQL API architectures from scratch.
- Generating comprehensive and valid OpenAPI 3.1 specifications.
- Modeling complex resource relationships and data schemas.
- Implementing standardized error handling, pagination, and filtering patterns.
- Planning long-term API versioning and deprecation strategies to avoid breaking changes.
How API Designer Works
- Analyze the domain requirements and identify core business entities and client needs.
- Model resources and their relationships to define the logical data structure and operations.
- Design endpoints using proper URI patterns, HTTP methods, and response codes.
- Specify the API contract using OpenAPI 3.1 standards with complete documentation.
- Plan for long-term maintenance by designing versioning, deprecation policies, and migration paths.
API Designer Setup
To add this tool to your Openclaw Skills environment, ensure your workspace is properly initialized. You can install and activate the skill using the following command:
openclaw install api-designer
Once configured, the agent will automatically trigger when it detects keywords such as resource modeling, GraphQL schema design, or OpenAPI specification requests.
API Designer Data Schema & Taxonomy
The skill manages API metadata through a structured hierarchy of specifications and documentation:
| Component | Format | Description |
|---|---|---|
| Contract | OpenAPI 3.1 (YAML/JSON) | The primary machine-readable API definition and source of truth. |
| Resource Model | Markdown | A textual representation of entities, relationships, and operations. |
| Documentation | Markdown | Human-readable endpoint guides, error catalogs, and auth flows. |
| Schema | JSON Schema / GraphQL | Precise data validation and type definitions for requests and responses. |
| Versioning | SemVer Mapping | Tracking of versions, deprecation dates, and backward compatibility. |
API Designer Advanced Features
- Automated generation of RFC 7807 compliant Problem Details for error responses.
- Support for advanced pagination strategy planning, including Cursor, Offset, and Keyset patterns.
- Native integration with other Openclaw Skills for seamless SDK generation and backend implementation.
- Multi-protocol support for bridging REST principles with GraphQL schema architecture.
- Strict enforcement of HATEOAS and REST maturity levels to ensure architectural purity.
SKILL.md
Loading
Related Openclaw Skills
AbbVie Information & Market Intelligence
A specialized intelligence module providing deep-dive data and market analysis on AbbVie's global biopharmaceutical operations.
audiopod: SkillBoss Audio Processing
A versatile audio toolkit for Openclaw Skills providing AI music generation, transcription, and advanced audio processing via a single API endpoint.
7-eleven Knowledge Card
A specialized corporate intelligence tool designed to provide structured insights and foundational business data regarding 7-eleven.
arXiv Research Assistant
A dedicated research assistant for searching, downloading, and summarizing academic papers from arXiv.org directly through your AI agent.
Architecture Designer
A principal-level AI architect skill for designing scalable systems, documenting ADRs, and evaluating technical trade-offs.
Work Critic
A high-stakes review skill that acts as a rigorous expert judge to identify critical weaknesses in your work before final delivery.
Featured*
