api-designer
Use when designing REST or GraphQL APIs, creating OpenAPI specifications, or planning API architecture. Invoke for resource modeling, versioning strategies, pagination patterns, error handling standards.
Why use this skill?
Use the OpenClaw API Designer to create scalable REST and GraphQL APIs, generate OpenAPI 3.1 specifications, and implement professional API versioning and error handling strategies.
Install via CLI (Recommended)
clawhub install openclaw/skills/skills/veeramanikandanr48/api-designerWhat This Skill Does
The api-designer skill acts as a senior API architect, assisting developers in designing scalable, secure, and developer-friendly REST and GraphQL APIs. It provides deep expertise in resource modeling, endpoint design, and the creation of industry-standard OpenAPI 3.1 specifications. By following this skill's structured workflow, you ensure your API designs adhere to RESTful principles, feature robust error handling, and maintain long-term viability through thoughtful versioning strategies. It effectively bridges the gap between high-level business requirements and low-level technical documentation.
Installation
To integrate this skill into your environment, use the OpenClaw CLI:
clawhub install openclaw/skills/skills/veeramanikandanr48/api-designer
Use Cases
- Drafting new REST or GraphQL architectures from scratch based on business data models.
- Generating complete OpenAPI 3.1 YAML or JSON specifications for existing legacy systems.
- Standardizing error responses and status code usage across a microservices landscape.
- Designing complex pagination strategies (Cursor vs. Offset) for large-scale data collection endpoints.
- Planning long-term versioning policies including deprecation notices and breaking change management.
Example Prompts
- "Design a set of REST endpoints for a library management system. Include endpoints for books, authors, and loans. Provide an OpenAPI 3.1 spec and explain your choice of pagination for the book collection."
- "I need to expose a GraphQL schema for a retail platform. Model the relationships between Products, Categories, and Suppliers, and explain how to handle auth-based field access."
- "Review this API endpoint design /api/v1/updateUserStatus and tell me why it violates REST principles. Suggest a standard-compliant alternative and an appropriate error response structure."
Tips & Limitations
- Tip: Always provide the specific data entities you need to model to get the most accurate OpenAPI schemas.
- Tip: If you are working on a massive enterprise system, ask the agent to focus on versioning strategies first to avoid future breaking changes.
- Limitation: The skill is focused on design and documentation; it does not write the server-side implementation code (e.g., Node.js or Python backend logic), though it can generate documentation for such code.
- Constraint: Ensure you strictly avoid verb-based URIs, as the skill is configured to reject non-RESTful patterns such as '/createResource'.
Metadata
Not sure this is the right skill?
Describe what you want to build — we'll match you to the best skill from 16,000+ options.
Find the right skillPaste this into your clawhub.json to enable this plugin.
{
"plugins": {
"official-veeramanikandanr48-api-designer": {
"enabled": true,
"auto_update": true
}
}
}Tags(AI)
Related Skills
better-auth
Self-hosted auth for TypeScript/Cloudflare Workers with social auth, 2FA, passkeys, organizations, RBAC, and 15+ plugins. Requires Drizzle ORM or Kysely for D1 (no direct adapter). Self-hosted alternative to Clerk/Auth.js. Use when: self-hosting auth on D1, building OAuth provider, multi-tenant SaaS, or troubleshooting D1 adapter errors, session caching, rate limits, Expo crashes, additionalFields bugs.
security-reviewer
Use when conducting security audits, reviewing code for vulnerabilities, or analyzing infrastructure security. Invoke for SAST scans, penetration testing, DevSecOps practices, cloud security reviews.
cli-developer
Use when building CLI tools, implementing argument parsing, or adding interactive prompts. Invoke for CLI design, argument parsing, interactive prompts, progress indicators, shell completions.
swift-expert
Use when building iOS/macOS applications with Swift 5.9+, SwiftUI, or async/await concurrency. Invoke for protocol-oriented programming, SwiftUI state management, actors, server-side Swift.
spark-engineer
Use when building Apache Spark applications, distributed data processing pipelines, or optimizing big data workloads. Invoke for DataFrame API, Spark SQL, RDD operations, performance tuning, streaming analytics.