API Design · Middle · Question 52 of 75

How can you catch breaking changes in an OpenAPI spec automatically?

✓Correct answer: Run a diff tool (e.g. oasdiff) in CI that compares the new spec with the published one and fails on breaking changes
2Breaking changes can't be detected
3Ask clients to report problems after release

Explanation

Combine with linting (Spectral) for style rules and contract tests to check that the implementation matches the spec.

Further reading

Test yourself

Take the API Design · Middle quiz: questions and options are shuffled, and you get a review of your mistakes at the end.