Standardize REST and GraphQL API design with schema-first patterns.
npx skills add https://github.com/rkz91/coco --skill api-design-principles-rkz91
Please help me install this Agent Skill. Skill: api-design-principles Source: https://github.com/rkz91/coco/tree/main/skills/api-design-principles Command: npx skills add https://github.com/rkz91/coco --skill api-design-principles-rkz91
This guide helps teams design intuitive, scalable, and maintainable REST and GraphQL APIs by providing a consolidated set of principles, patterns, and best practices to prevent common design pitfalls.
Review the REST and GraphQL design principles and implement the recommended patterns in your next API specification.
High-intent search queries and answers about installing and using this skill.
Core REST and GraphQL API design principles involve a schema-first approach, resource-oriented endpoints, proper HTTP semantics, and strongly typed schemas to ensure consistency, scalability, and maintainability.
Standardize API versioning and pagination by applying consistent patterns during API design, using established versioning strategies for REST endpoints and structured pagination techniques for GraphQL queries.
Standardize API error handling by enforcing consistent patterns and best practices across REST and GraphQL, ensuring predictable developer experiences and maintainable specifications during API design reviews.
Choosing GraphQL over REST depends on your API design needs, where GraphQL's schema-first design, strongly typed schemas, and query flexibility contrast with REST's resource-oriented endpoints and HTTP semantics.
Yes, you can apply these API design principles during specification reviews to enforce schema-first approaches, validate consistent patterns, and identify areas for improvement in versioning, pagination, and error handling.
Establish team API standards by applying consistent documentation strategies and deprecation patterns across REST and GraphQL, using reference materials to guide collective decision-making and maintain design consistency.
cshyangPlan and execute a project discovery phase to define requirements and scope.
nateaGenerate API test coverage from OpenAPI specifications across REST and GraphQL.
heaptracetechnologyAutomate API contract testing with schema validation and OpenAPI checks.
jmaglyGenerate test data factories from TypeScript interfaces, Prisma schemas, JSON schemas, database migrations, or OpenAPI specs.
