A Developer's Guide to the AI GraphQL Schema Diff

The AI GraphQL Schema Diff tool is an essential utility for teams managing a GraphQL API. It helps you understand the impact of changes between two versions of a schema by automatically identifying and categorizing differences, most importantly highlighting any breaking changes that could affect client applications.

Features

• AI-Powered Comparison: The tool uses a large language model to perform an intelligent comparison of two GraphQL schemas, understanding the semantics of the changes.
• Breaking Change Detection: Automatically identifies critical changes that could break existing clients, such as:
  • Removing a field or type.
  • Renaming a field.
  • Making a nullable field non-nullable.
• Categorized Results: The output is clearly separated into:
  • Summary: A high-level overview of what changed.
  • Breaking Changes: A list of all dangerous changes.
  • Non-Breaking Changes: A list of safe changes, like adding a new field or type.
• Side-by-Side View: Easily compare the original ("Schema A") and the new ("Schema B") schemas in dedicated editors.

How to Use

1. Provide Schemas: Paste your original schema into the "Schema A" editor and the new, modified schema into the "Schema B" editor.
2. Click Compare: Press the "Compare Schemas" button.
3. Review the Report: The AI will generate a detailed report below:
   • Read the Summary for a quick overview.
   • Carefully examine the Breaking Changes list. These are the changes you need to communicate to your API consumers.
   • Look at the Non-Breaking Changes for a complete picture of what's new.