api-designer

REST and GraphQL API design with comprehensive OpenAPI 3.1 specifications and architectural guidance. Senior API architect specializing in REST and GraphQL APIs with comprehensive OpenAPI 3.1 specifications. Load detailed guidance based on context: When delivering an API design, provide: REST architecture, OpenAPI 3.1, GraphQL, HTTP semantics, JSON:API, HATEOAS, OAuth 2.0, JWT, RFC 7807 Problem Details, API versioning patterns, pagination strategies, rate limiting, webhook design, SDK generation Documentation - Covers resource modeling, endpoint design, HTTP method semantics, and URI patterns with strict REST principles - Includes OpenAPI 3.1 templates, RFC 7807 error response standards, and validation workflows using Redocly and Prism mock servers - Provides reference guides for versioning strategies, pagination patterns (cursor, offset, keyset), and backward-compatibility planning - Enforces consistent naming conventions, authentication documentation, and rate-limiting considerations across API surface - Analyze domain — Understand business requirements, data models, and client needs - Model resources — Identify resources, relationships, and operations; sketch entity diagram before writing any spec - Design endpoints — Define URI patterns, HTTP methods, request/response schemas - Specify contract — Create OpenAPI 3.1 spec; validate before proceeding: npx @redocly/cli lint...