Skip to content

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.

After deployment, Assurance:

  1. Reads your OAS — Extracts every operation, parameter combination, header requirement, and response schema
  2. Generates test permutations — Creates hundreds of request combinations from your spec’s parameters, query filters, headers, and body schemas
  3. Runs against your API — Sends real requests to your deployed endpoint
  4. Validates responses — Checks status codes, response schemas, data types, pagination, and latency against your OAS and SLA
  5. Reports results — Scores the API and flags any failures
AreaChecks
Schema conformanceResponse body matches OAS schemas — types, required fields, enums
Status codesCorrect codes for success, validation errors, not found, auth failures
PaginationCollection endpoints return proper pagination metadata
HeadersRequired response headers present (Content-Type, Cache-Control, etc.)
LatencyResponse times within SLA targets (P95, P99)
Error responsesError format matches the standard error schema
SecurityUnauthenticated requests are properly rejected
  • 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

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.

Combine Assurance with blue-green revisions for safe deployments:

  1. Deploy to staging revision
  2. Run Assurance against staging
  3. If all tests pass → activate revision
  4. If tests fail → discard revision, active stays untouched

Your consumers never see a broken deployment.