api-design

Included with Lifetime

$97 forever

Guide API design for REST, GraphQL, gRPC, and CLI interfaces. Use this skill when designing new APIs, reviewing existing API contracts, or establishing API conventions for a project. Produces consistent, well-documented API specifications.

Design

What this skill does


# API Design

Design consistent, well-documented APIs across REST, GraphQL, gRPC, and CLI interfaces.

## When to Use

- Designing new API endpoints or commands
- Reviewing existing API contracts for consistency
- Establishing API naming and versioning conventions
- Planning backward-compatible API changes
- Generating API documentation or OpenAPI specs

## Principles

1. **Consistency** - Same patterns everywhere (naming, error format, pagination)
2. **Discoverability** - A developer should guess the right endpoint/flag without reading docs
3. **Backward compatibility** - Additions are safe; removals and renames require versioning
4. **Minimal surface** - Expose only what consumers need; internal details stay internal
5. **Self-describing errors** - Error responses should tell the caller what went wrong and how to fix it

## REST API Checklist

### Naming

- Use plural nouns for resources: `/users`, `/tasks`
- Use kebab-case for multi-word paths: `/user-settings`
- Nest for ownership: `/users/{id}/tasks`
- Use verbs only for actions that don't map to CRUD: `/tasks/{id}/approve`

### HTTP Methods

| Method | Purpose | Idempotent |
|--------|---------|------------|
| GET | Read | Yes |
| POST | Create / action | No |
| PUT | Full replace | Yes |
| PATCH | Partial update | Yes |
| DELETE | Remove | Yes |

### Response Format

```json
{
  "data": { ... },
  "meta": { "page": 1, "total": 42 }
}
```

Error format:
```json
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Human-readable description",
    "details": [
      { "field": "email", "reason": "required" }
    ]
  }
}
```

### Status Codes

| Code | Use |
|------|-----|
| 200 | Success (with body) |
| 201 | Created |
| 204 | Success (no body) |
| 400 | Client error (validation) |
| 401 | Not authenticated |
| 403 | Not authorized |
| 404 | Not found |
| 409 | Conflict (duplicate, state mismatch) |
| 422 | Unprocessable (semantically invalid) |
| 500 | Server error |

### Pagination

Use cursor-based for large datasets, offset-based for simple cases:

```
GET /tasks?cursor=abc123&limit=20
GET /tasks?page=2&per_page=20
```

### Versioning

- Prefer URL prefix: `/v1/tasks`, `/v2/tasks`
- Use header-based only when URL versioning is impractical

## CLI API Checklist

### Command Structure

```
<tool> <noun> <verb> [args] [--flags]
```

Example: `synapse send gemini "Review code" --wait`

### Flag Conventions

- Long form: `--output`, `--verbose`
- Short form for common flags: `-o`, `-v`
- Boolean flags: `--force`, `--no-color`
- Repeatable: `--attach file1 --attach file2`
- Mutually exclusive groups: `--wait | --notify | --silent`

### Output

- Default: human-readable
- `--json`: machine-readable JSON
- `--quiet` / `-q`: minimal output
- Exit codes: 0 = success, 1 = error, 2 = usage error

## Workflow

### Step 1: Define Resources / Commands

List the entities and actions the API must support.

### Step 2: Map to Endpoints / Subcommands

Apply naming conventions to produce the API surface.

### Step 3: Define Request / Response Schemas

Specify required and optional fields, types, and validation rules.

### Step 4: Document Error Cases

For each endpoint, list possible error responses and their meaning.

### Step 5: Review for Consistency

Cross-check naming, error format, and pagination across all endpoints.

Files: 1

Size: 3.6 KB

Complexity: 13/100

Category: Design

Source: https://github.com/s-hiraoku/synapse-a2a/tree/main/plugins/synapse-a2a/skills/api-design

Related in Design

contribute

Included

Local-only OSS contribution command center. Auto-refreshes the user's in-flight PR and issue state on invoke so conversations start with full context — no need to brief Claude on what's in flight. Helps the user find issues to contribute to on GitHub, builds per-repo dossiers of what each upstream expects (CLA, DCO, branch convention, AI policy, draft-first, review bots, issue templates), runs deterministic gates before any external action so AI-assisted contributions don't reach maintainers as slop. State is markdown-only: candidate files at ~/.contribute-system/candidates/, repo dossiers at ~/.contribute-system/research/, append-only event log at ~/.contribute-system/log.jsonl. No database, no cloud calls. Use when the user asks about their PRs / issues / contributions, wants to find new work to take on, claim an issue, build/refresh a repo's dossier, or draft a Design Issue or PR. Trigger with "/contribute", "what's my PR status", "find a contribution", "claim issue X", "draft a Design Issue for Y", "refresh dossier for Z".

Designscripts

architectural-analysis

Included

User-triggered deep architectural analysis of a codebase or scoped subtree across eight modes — information architecture, data flow, integration points, UI surfaces, interaction patterns, data model, control flow, and failure modes. This skill should be used when the user asks to "diagram this codebase," "map the architecture," "show the data flow," "give me an ERD," "trace control flow," "find the integration points," "verify the layout pattern," "audit the UX architecture," or any similar request whose primary deliverable is mermaid diagrams plus cited reports under docs/architecture/. Dispatches haiku/sonnet sub-agents in parallel for per-mode exploration, then verifies every citation mechanically before any node lands in a diagram. Not for one-off prose explanations of code (use code-explanation) or for high-level system design from scratch (use system-design).

Designscripts

mcp

Included

Model Context Protocol (MCP) server development and tool management. Languages: Python, TypeScript. Capabilities: build MCP servers, integrate external APIs, discover/execute MCP tools, manage multi-server configs, design agent-centric tools. Actions: create, build, integrate, discover, execute, configure MCP servers/tools. Keywords: MCP, Model Context Protocol, MCP server, MCP tool, stdio transport, SSE transport, tool discovery, resource provider, prompt template, external API integration, Gemini CLI MCP, Claude MCP, agent tools, tool execution, server config. Use when: building MCP servers, integrating external APIs as MCP tools, discovering available MCP tools, executing MCP capabilities, configuring multi-server setups, designing tools for AI agents.

Designscripts

react-native-skia

Included

Design, build, debug, and optimise high-polish animated graphics in React Native or Expo using @shopify/react-native-skia, Reanimated, and Gesture Handler. Use when the user wants canvas-driven UI, shaders, paths, rich text, image filters, sprite fields, Skottie, video frames, snapshots, web CanvasKit setup, or performance tuning for custom motion-heavy elements such as loaders, hero art, cards, charts, progress indicators, particle systems, or gesture-driven surfaces. Also use when the user asks for fluid, glow, glass, blob, parallax, 60fps/120fps, or GPU-friendly animated effects in React Native, even if they do not explicitly say "Skia". Do not use for ordinary form/layout work with standard views.

Designscripts

plaid

Included

Product Led AI Development — guides founders from idea to launched product. Six capabilities: Idea (discover a product idea), Validate (pressure-test the idea against fatal flaws, problem reality, competition, and 2-week MVP feasibility), Plan (vision intake + document generation), Design (translate image references into a design.md spec), Launch (go-to-market strategy), and Build (roadmap execution). Use when someone says "PLAID", "plaid idea", "help me find an idea", "product idea", "idea from my business", "idea from my expertise", "plaid validate", "validate my idea", "pressure-test", "is this idea good", "find fatal flaws", "validate the problem", "plan a product", "define my vision", "generate a PRD", "product strategy", "plaid design", "design from image", "translate image to design", "create design.md", "extract design tokens", "plaid launch", "go-to-market", "launch plan", "GTM strategy", "launch playbook", "plaid build", "build the app", "start building", or "execute the roadmap".

Designscripts

nextjs-framer-motion-animations

Included

Adds production-safe Motion for React or Framer Motion animations to Next.js apps, including reveal, hover and tap micro-interactions, whileInView, stagger, AnimatePresence, layout and layoutId transitions, reorder, scroll-linked UI, and lightweight route-content transitions. Use when the user asks to add, refactor, or debug Motion or Framer Motion in App Router or Pages Router codebases, especially around server/client boundaries, reduced motion, LazyMotion, bundle size, hydration, or route transitions. Avoid for GSAP-style timelines, WebGL or 3D scenes, heavy scroll storytelling, or CSS-only effects unless Motion is explicitly requested.

Designscripts