A new API version works, but the city’s applications do not
An environmental data service introduces a new response structure. The server tests pass, yet a pedestrian heat application interprets a missing field as zero degrees. Consumer compatibility ensures that changes are tested against how real applications use the data.
Identify critical consumers
Map the applications, dashboards and research workflows that depend on the interface, especially those supporting important decisions.
Document the expected contract
Field names, units, timestamps, missing-value rules, identifiers and quality flags should have clear meaning.
Test realistic requests and responses
Use representative queries, empty datasets, delayed readings, invalid values and error responses. A simple successful request is not enough.
Manage breaking changes
Where appropriate, use versioning, migration guidance and suitable transition periods so consumers can adapt safely.
Protect scientific meaning
An interface may remain syntactically compatible while the underlying measurement method or unit changes. Semantic compatibility matters.
Observe production behaviour
Monitor relevant errors, unusual client patterns and reports from downstream users after release.
Give failures an owner
When compatibility problems arise, establish which team investigates, communicates and verifies the correction.
Break-test: an old client treats a new quality flag as valid data
Can the service detect the problem before it creates a misleading public display?
Connected knowledge
See API Data Contract Testing, API Versioning and NEA.