API Regression Check for CI (GitHub Actions)
Fail a pull request when an API response changes in a breaking way. Generate the workflow, run a dry check in your browser, use the CLI in CI.
CI Regression Check tool
Pro previewCI regression check is a Pro feature, free to use while IntegrateKit is in beta.
Runs entirely in your browser. Nothing you paste is uploaded or stored.
1. Try the check in your browser
2. Generate the GitHub Actions workflow
3. Get the checker
The checker is free and open source (MIT). Its code, README and a GitHub Actions example are on GitHub. Install it with npm install -g integratekit-check. The exit codes are 0 for pass, 1 for a regression and 2 for bad input.
Found a problem or have an idea for this tool? Send feedback.
About this tool
Save a known-good API response in your repository. In CI, fetch the new response and run the checker: it compares the two by structure, ignores fields you tell it to ignore, and fails the build when a difference is at or above the severity you choose.
This page lets you try the check in your browser and generates the GitHub Actions workflow. The checker itself is a small Node script. It is free and open source on GitHub: https://github.com/puru-savi/integratekit-check
How to use it
- Paste a baseline and a new response to try the check.
- Choose how strict the check should be.
- Copy the workflow into your repository and install the checker with npm.
Limitations
- Compares JSON only.
- Each baseline covers one request.
Example
{"orderId":1001,"status":"SHIPPED","total":149.9}
{"orderId":"1001","status":"SHIPPED"}IntegrateKit regression check: FAIL (2 breaking, 0 warning, 0 info)
[breaking] $.orderId: 1001 -> "1001" (TYPE_CHANGED)
[breaking] $.total: 149.9 -> (absent) (FIELD_REMOVED)Common use cases
Pull request gates
Block a merge that removes or retypes a field consumers rely on.
Upgrades
Prove a framework or dependency upgrade left the API unchanged.
Contract drift
Notice when a downstream service changes its response.