api-design-assistant
Design or review REST/RPC API contracts that are consistent, evolvable, and hard to misuse. Use when defining new endpoints, reviewing an API surface, or resolving naming/versioning/error-shape questions.
Signing
SignedSLSA L2- Signed by
- skills-hub.ai distributor
- Method
- Distributor-signed by skills-hub.aiCryptographically signed by the skills-hub.ai distributor key at publish time.
- Signed
Install this skill
Run this command in your terminal. No account required — it auto-detects your AI tool and installs the skill file.
npx @skills-hub-ai/cli install api-design-assistantSetup by platform
Install
One-click setup for your editorRun in your project root
npx @skills-hub-ai/cli install api-design-assistant --target claude-codeExamples
Prompt
Review the following API endpoint for user creation: POST /users with body {"name": "Alice"}. Is this well-designed?Output
Critical: The endpoint lacks a request body schema and a response schema, making it unclear what data is required and returned. This can lead to client errors and inconsistent implementations. Fix: Define an OpenAPI schema with explicit request and response objects, e.g., {"data": {"id": "string", "name": "string", "created_at": "ISO8601"}}. Also, include status codes 201 with Location header for resource creation.Prompt
Evaluate the API design for fetching order details: GET /orders/{orderId} with no pagination or filtering options.Output
Low: While the endpoint is straightforward, it might benefit from optional filtering or expansion parameters for related data (e.g., /orders/{orderId}?expand=items). This enhances flexibility without breaking existing clients. Consider adding optional query params and documenting them in the schema to improve evolvability.Instructions
Security
Reviews (0)
Frequently asked questions about api-design-assistant
What does the api-design-assistant skill do?
Design or review REST/RPC API contracts that are consistent, evolvable, and hard to misuse. Use when defining new endpoints, reviewing an API surface, or resolving naming/versioning/error-shape questions. It's a reusable SKILL.md instruction set that loads into your AI coding assistant on demand, no prompt engineering, no copy-pasting every session.
How do I install the api-design-assistant skill?
Run `npx @skills-hub-ai/cli install api-design-assistant` from your terminal. The CLI writes the SKILL.md to the correct location for your AI tool (e.g. ~/.claude/skills/api-design-assistant/ for Claude Code or ~/.cursor/skills/ for Cursor with --target cursor) and adds it to your project's .skills.json lockfile.
Which AI tools does api-design-assistant work with?
api-design-assistant runs in Claude Code, Cursor, Windsurf, Cline, Codex CLI, Gemini CLI. It follows the open Agent Skills standard (SKILL.md), so the same skill works in every supported tool without modification.
Is the api-design-assistant skill free?
Yes. Every skill on skills-hub.ai is free and open-source. There are no premium tiers, paywalls, or usage limits. You only pay for whatever AI assistant you're already using.
How do I use api-design-assistant after installing it?
In Claude Code, type `/api-design-assistant` (or whatever slash command the skill registers) and the AI follows the skill's instructions immediately. You can also reference it by name in natural language, your AI loads the skill into context when relevant.
Can I share the api-design-assistant skill with my team?
Yes. Commit your project's .skills.json lockfile and teammates run `npx @skills-hub-ai/cli install` (no args) to install every skill at the exact version you pinned. Organization-scoped installs work via skills-hub.ai organizations.