designing-apis

REST API design establishes clear endpoints using URL conventions, HTTP status codes, and versioning strategies. This skill guides endpoint naming, resource hierarchy, and version management to ensure consistency across teams and reduce breaking changes in production.

GraphQL schema design defines types, queries, and mutations with clear documentation practices. This approach enforces naming conventions and patterns that make schemas self-documenting and easier for clients to consume and maintain.

OpenAPI documentation templates standardize how you describe REST endpoints, parameters, and responses. This skill provides templates and conventions that accelerate API onboarding and enable contract-driven development across teams.

API contract reviews validate endpoint design, error handling guidelines, and schema compliance against REST and GraphQL standards. This process catches inconsistencies early and ensures your API follows industry conventions before implementation.

Yes, this skill covers both REST endpoint design with HTTP conventions and GraphQL schema patterns. You can apply REST or GraphQL design guidance depending on your project's architecture and client requirements.

Error handling guidelines establish standardized status codes, error response formats, and documentation practices. This ensures clients can anticipate and handle errors uniformly whether your API uses REST or GraphQL.