api-design-review

To check API design for backward compatibility, you can review REST and GraphQL schemas to identify breaking-change risks. The process analyzes OpenAPI, JSON Schema, and GraphQL SDL inputs to generate a comprehensive report on confirmed design issues and compatibility constraints.

Automating REST API contract quality reviews involves evaluating OpenAPI specifications against specific design rubrics. This checks for contract quality, error shapes, idempotency, versioning, and pagination, producing a detailed report of confirmed design issues and recommended improvements.

Reviewing GraphQL SDL for design quality requires evaluating the schema against GraphQL-specific review rubrics. This analysis checks for contract quality, error shapes, and backward compatibility, outputting a report detailing design issues and potential breaking-change risks.

Yes, the API review process supports both OpenAPI and GraphQL SDL formats. It operates in two distinct modes, REST and GraphQL, utilizing JSON Schema and GraphQL SDL respectively to analyze designs for contract quality and compatibility issues.

During an API quality review, the system checks for contract quality, error shapes, idempotency, versioning, pagination, and backward compatibility. It evaluates the provided API design principles to output a report on confirmed issues, improvements, and breaking-change risks.

Yes, reviewing API contracts requires knowledge of API design principles and contract enforcement. The automated review utilizes this foundation alongside OpenAPI and GraphQL SDL inputs to accurately detect quality issues and compatibility risks.