DEV Community

Maximus Beato
Maximus Beato

Posted on • Originally published at apimesh.xyz

how to keep your api schemas in sync without manual diffing

the problem

maintaining accurate api documentation becomes a headache when api schemas evolve over time. manually tracking differences across versions is error-prone and time-consuming.

the solution

api-schema-diff automatically fetches multiple versions of your rest or graphql schemas from public endpoints and compares them, highlighting differences in data structures, fields, and endpoints.



curl -X GET https://api-schema-diff.apimesh.xyz/check?endpoints=https%3A%2F%2Fapi1.example.com%2Fschema,https%3A%2F%2Fapi2.example.com%2Fschema


response example:
{
  "schema_a": "v1-schema-data",
  "schema_b": "v2-schema-data",
  "differences": [ ... ]
}

## how it works
the api fetches schemas directly from your provided endpoints, parses the schema data for REST or GraphQL APIs, and compares their structure, fields, and endpoints. it then returns a clear diff.

## try it
no account needed, just a couple of calls to see how your schemas compare. limited free previews available, paid plans start at $0.005 per call. check it out: https://api-schema-diff.apimesh.xyz
Enter fullscreen mode Exit fullscreen mode

Top comments (0)