Design API contracts for REST, GraphQL, and gRPC contexts.
npx skills add https://github.com/majiayu000/claude-arsenal --skill api-design-majiayu000
Please help me install this Agent Skill. Skill: api-design Source: https://github.com/majiayu000/claude-arsenal/tree/main/skills/api-design Command: npx skills add https://github.com/majiayu000/claude-arsenal --skill api-design-majiayu000
REST/GraphQL/gRPC API designs are often under-specified, leading to mismatches between teams. This Skill provides best practices for contract-first API design, OpenAPI 3.2, GraphQL Federation, and gRPC streaming to ensure consistent contracts across REST, GraphQL, and gRPC.
Draft a REST OpenAPI 3.2 spec skeleton for /users and a basic GraphQL schema for a User type; consider gRPC streaming for internal services.
High-intent search queries and answers about installing and using this skill.
REST API design follows contract-first approach using OpenAPI 3.2 specs. Define versioning strategy upfront, apply RFC 7807-compliant errors, standard status codes, and idempotency patterns to ensure consistent contracts before implementation begins.
REST suits MVP and public APIs with straightforward CRUD operations. GraphQL serves data-rich clients needing flexible queries and schema federation. gRPC optimizes internal microservices with streaming and binary protocols for performance.
Schema evolution requires versioning strategy and careful field deprecation. Contract-first design using OpenAPI, GraphQL Federation schemas, or gRPC proto definitions ensures teams align on changes before implementation, preventing breaking changes.
OpenAPI 3.2 is REST-native, but contract-first principles apply across protocols. GraphQL uses federation schemas; gRPC uses proto definitions. Each protocol has dedicated specification formats, though cross-protocol interoperability patterns exist for polyglot architectures.
Contract-first design includes endpoint definitions, request/response schemas, authentication requirements, error codes, pagination approach (cursor-based), idempotency rules, and security constraints. OpenAPI 3.2, GraphQL schemas, or gRPC protos document these formally.
Cursor-based pagination encodes position state in opaque tokens, improving performance over offset-based queries. Implement consistently across REST endpoints, GraphQL resolvers, and gRPC streaming responses to handle large datasets reliably.
erichowensDesign and validate REST, GraphQL, and gRPC API contracts and architectures.
Doyajin174Design OpenAPI schemas and generate client types from specifications.
apassuelloGenerate Pact consumer tests and validate responses against OpenAPI specifications.
HyperscapeAIConfigure API gateways with rate limiting and JWT authentication.
