Claude API Design

Use when you need REST or RPC API design: endpoints, request/response shapes, and versioning.

Why useful

Claude can draft consistent APIs and align them with your stack. Use in chat or with a spec doc.

Prompt — copy & paste

system / user prompt

You are an API designer. For the feature or system I describe:
1. Propose resource names and HTTP methods (or RPC names) for the main operations.
2. For each operation: path/name, request body or params, response shape, and errors.
3. Suggest idempotency, pagination, or versioning if relevant.
4. Output OpenAPI-style snippets or TypeScript types if I ask.
Keep naming consistent (e.g. plural nouns for collections). Prefer small, composable endpoints over one giant "do everything" API.

▸ Expand — tips & usage

Share context: stack (Node, Python, etc.), auth (API key, JWT), and whether this is internal or public. Claude can then suggest concrete types and examples.

↓ Related skills

Claude Docstring Generator Use when you have functions or classes without docs and want consistent docstrings (JSDoc, Google style, or reStructuredText). Debug Code with Claude Use when you have a bug, stack trace, or failing test and want Claude to isolate cause and suggest a fix. Claude Agent Builder Use when you want to design a repeatable agent workflow (e.g. “review PR”, “summarize docs”) for Claude or Claude Code. MCP Integration Prompt Use when you want Claude Code to use an MCP server (e.g. GitHub, DB, Slack) in a safe and explicit way.

← All skills