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
earnings-calendar
This skill retrieves upcoming earnings announcements for US stocks using the Financial Modeling Prep (FMP) API. Use this when the user requests earnings calendar data, wants to know which companies are reporting earnings in the upcoming week, or needs a weekly earnings review. The skill focuses on mid-cap and above companies (over $2B market cap) that have significant market impact, organizing the data by date and timing in a clean markdown table format. Supports multiple environments (CLI, Desktop, Web) with flexible API key management.
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.
dividend-growth-pullback-screener
Use this skill to find high-quality dividend growth stocks (12%+ annual dividend growth, 1.5%+ yield) that are experiencing temporary pullbacks, identified by RSI oversold conditions (RSI ≤40). This skill combines fundamental dividend analysis with technical timing indicators to identify buying opportunities in strong dividend growers during short-term weakness.
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.
options-strategy-advisor
Options trading strategy analysis and simulation tool. Provides theoretical pricing using Black-Scholes model, Greeks calculation, strategy P/L simulation, and risk management guidance. Use when user requests options strategy analysis, covered calls, protective puts, spreads, iron condors, earnings plays, or options risk management. Includes volatility analysis, position sizing, and earnings-based strategy recommendations. Educational focus with practical trade simulation.