Assurance
Assurance is Apiway’s post-deployment validation engine. It generates test permutations from your OpenAPI specification and runs them against your live API to confirm everything works as designed.
What It Does
Section titled “What It Does”After deployment, Assurance:
- Reads your OAS — Extracts every operation, parameter combination, header requirement, and response schema
- Generates test permutations — Creates hundreds of request combinations from your spec’s parameters, query filters, headers, and body schemas
- Runs against your API — Sends real requests to your deployed endpoint
- Validates responses — Checks status codes, response schemas, data types, pagination, and latency against your OAS and SLA
- Reports results — Scores the API and flags any failures
What It Validates
Section titled “What It Validates”| Area | Checks |
|---|---|
| Schema conformance | Response body matches OAS schemas — types, required fields, enums |
| Status codes | Correct codes for success, validation errors, not found, auth failures |
| Pagination | Collection endpoints return proper pagination metadata |
| Headers | Required response headers present (Content-Type, Cache-Control, etc.) |
| Latency | Response times within SLA targets (P95, P99) |
| Error responses | Error format matches the standard error schema |
| Security | Unauthenticated requests are properly rejected |
When It Runs
Section titled “When It Runs”- Post-deployment — Automatically after a revision is activated
- On demand — Triggered manually from the management UI or API
- Scheduled — Recurring validation to catch runtime regressions
SLA Validation
Section titled “SLA Validation”If your API has an OpenSLA definition, Assurance validates latency against your committed targets:
- P95 latency — 95th percentile response time must be within the SLA guarantee
- P99 latency — 99th percentile for tail latency
- Availability — Success rate across all test permutations
This catches performance regressions before your consumers notice them.
Zero-Regression Deployment
Section titled “Zero-Regression Deployment”Combine Assurance with blue-green revisions for safe deployments:
- Deploy to staging revision
- Run Assurance against staging
- If all tests pass → activate revision
- If tests fail → discard revision, active stays untouched
Your consumers never see a broken deployment.