Skip to content

charlieviettq/awesome-agent-skill / .claude/skills/api-and-interface-design

api-and-interface-design

Verified

Design API and module boundaries with clear contracts, error semantics, pagination, and additive compatibility. Use before implementing REST/GraphQL endpoints, SDKs, or public module APIs.

API and Interface Design

Contract-first design for HTTP APIs, GraphQL, CLI surfaces, and library module boundaries. Complements secure-api-design (security) and agent-tool-contracts (LLM tools) with general interface ergonomics and evolution rules.

When to use

  • New public or cross-team API
  • Breaking-change review
  • Designing pagination, filtering, idempotency, or error shapes

When not to use

  • Internal refactor with no boundary change
  • Security-only audit (use secure-api-design)
  • Agent tool schema only (use agent-tool-contracts)

Design checklist

Contract

  • Resource naming consistent (nouns, plural collections)
  • Versioning strategy documented (URL prefix, header, or additive-only)
  • Request/response schemas with examples for happy path + common errors
  • Idempotency keys for mutating operations where retries matter

Errors

  • Stable machine-readable codes separate from human messages
  • HTTP/status mapping documented; no stack traces in client responses
  • Validation errors: field-level detail when safe (no PII leakage)

Pagination and lists

  • Cursor-based preferred for large/live datasets; offset only when bounded
  • Default and max page size documented
  • Sort/filter params explicit; reject unknown params predictably

Compatibility

  • Additive changes only in minor versions
  • Deprecation headers or sunset dates for removals
  • Consumer migration notes in changelog

Observability

  • Correlation/request IDs in responses or logs
  • Rate-limit headers where applicable

Workflow

  1. Draft resource model and primary use cases
  2. Write example requests/responses (including errors)
  3. Run doubt-driven-review or secure-api-design for high-risk surfaces
  4. Implement with tests locked to contract examples

Output

  • Short design note or OpenAPI/GraphQL schema sketch
  • Compatibility and deprecation table if evolving an existing API
brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation).Stars: 321kUpdated Claude CodeCodexVerifiedInstall
brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply.Stars: 197kUpdated Claude CodeCodexVerifiedInstall
frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults.Stars: 197kUpdated Claude CodeCodexVerifiedInstall
mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK).Stars: 197kUpdated Claude CodeCodexVerifiedInstall