OpenAPI JSON Change & Declared Consumer Impact Checker
Pricing
$0.05 / complete validation report
Compare supported OpenAPI JSON changes against explicitly declared consumers. Selected local checks; no exhaustive compatibility certification.
You can access the OpenAPI JSON Change & Declared Consumer Impact Checker 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_json": `{12 "openapi": "3.1.0",13 "info": {"title": "Orders API", "version": "1.0.0"},14 "paths": {15 "/orders/{id}": {16 "get": {17 "parameters": [{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}],18 "responses": {"200": {"content": {"application/json": {"schema": {"type": "object", "properties": {"id": {"type": "string"}, "total": {"type": "number"}}}}}}}19 }20 }21 }22}`,23 "candidate_json": `{24 "openapi": "3.1.0",25 "info": {"title": "Orders API", "version": "1.1.0"},26 "paths": {27 "/orders/{id}": {28 "get": {29 "parameters": [30 {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}},31 {"name": "tenant", "in": "header", "required": true, "schema": {"type": "string"}}32 ],33 "responses": {"200": {"content": {"application/json": {"schema": {"type": "object", "properties": {"id": {"type": "string"}}}}}}}34 }35 }36 }37}`,38 "consumers_json": `{39 "schema_version": "openapi-consumer-registry@1",40 "consumers": [41 {"consumer_id": "checkout", "criticality": "critical", "operations": ["GET /orders/{id}"]},42 {"consumer_id": "reporting", "criticality": "medium", "operations": ["GET /orders/{id}"]}43 ]44}`45};46
47// Run the Actor and wait for it to finish48const run = await client.actor("biztoolsus/openapi-consumer-impact").call(input);49
50// Fetch and print Actor results from the run's dataset (if any)51console.log('Results from dataset');52console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);53const { items } = await client.dataset(run.defaultDatasetId).listItems();54items.forEach((item) => {55 console.dir(item);56});57
58// 📚 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 JSON Change & Declared Consumer Impact Checker API in JavaScript or TypeScript, providing convenience functions and automatic retries on errors.
Install the apify-client
$npm install apify-clientOther API clients include: