api-design-principles

To design REST and GraphQL APIs, start by creating a design brief covering REST endpoints, GraphQL schema, pagination, and error handling. This skill provides templates and reference patterns to guide the specification process for new services.

You can standardize API design patterns using a pattern library that covers REST resources, pagination, versioning, and error handling. This skill consolidates best practices to enforce consistency during architectural reviews and governance across teams.

Yes, you can use this for architectural reviews of existing OpenAPI specifications. It enforces standards-based design guidelines, checking existing REST and GraphQL schemas against best practices for versioning, pagination, and error handling.

The best way to version REST and GraphQL APIs for scalability is applying consolidated versioning guidelines and pattern libraries. This skill provides reference patterns to help teams avoid common pitfalls and deliver developer-friendly APIs that scale.

Yes, this skill supports both REST and GraphQL documentation guidelines. It enforces schema-first design and provides reference patterns from its assets to ensure API documentation remains consistent and developer-friendly across new projects.