OpenAPI Consumer Breakage Gate
Pricing
from $100.00 / 1,000 consumer gate completeds
Compare OpenAPI 3.x contracts with versioned consumer profiles, checked waivers, stable findings, SARIF, JUnit, JSON, and Markdown evidence.
You can access the OpenAPI Consumer Breakage Gate programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in API & Integrations in Apify Console.
1import { ApifyClient } from 'apify-client';2
3// Initialize the ApifyClient with your Apify API token4// Replace the '<YOUR_API_TOKEN>' with your token5const client = new ApifyClient({6 token: '<YOUR_API_TOKEN>',7});8
9// Prepare Actor input10const input = {11 "baseline": {12 "content": {13 "openapi": "3.1.0",14 "info": {15 "title": "Store QA Widgets API",16 "version": "1.0.0"17 },18 "paths": {19 "/widgets": {20 "get": {21 "operationId": "listWidgets",22 "responses": {23 "200": {24 "description": "OK"25 }26 }27 }28 }29 }30 }31 },32 "revision": {33 "content": {34 "openapi": "3.1.0",35 "info": {36 "title": "Store QA Widgets API",37 "version": "2.0.0"38 },39 "paths": {}40 }41 },42 "consumerProfile": {43 "id": "store-qa-consumer",44 "version": "1",45 "minimumLevel": "WARN",46 "severityOverrides": {}47 },48 "waivers": [],49 "evaluationDate": "2026-09-16"50};51
52// Run the Actor and wait for it to finish53const run = await client.actor("ceddl/openapi-consumer-breakage-gate").call(input);54
55// Fetch and print Actor results from the run's dataset (if any)56console.log('Results from dataset');57console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);58const { items } = await client.dataset(run.defaultDatasetId).listItems();59items.forEach((item) => {60 console.dir(item);61});62
63// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docsThe Apify API client for JavaScript is the official library that allows you to use OpenAPI Consumer Breakage Gate API in JavaScript or TypeScript, providing convenience functions and automatic retries on errors.
Install the apify-client
$npm install apify-clientOther API clients include: