OpenAPI Change Preflight | API Contract Checks
Pricing
from $500.00 / 1,000 completed api spec comparisons
Compare two OpenAPI JSON specs for removed operations, required inputs and selected type or enum changes. Download HTML, CSV and JSON review reports.
You can access the OpenAPI Change Preflight | API Contract Checks 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.
# Set API token$API_TOKEN=<YOUR_API_TOKEN>
# Prepare Actor input$cat > input.json << 'EOF'<{< "previousSpec": "{\n \"openapi\": \"3.1.2\",\n \"info\": {\n \"title\": \"Synthetic Orders API\",\n \"version\": \"1.0\"\n },\n \"paths\": {\n \"/orders\": {\n \"get\": {\n \"parameters\": [\n {\n \"name\": \"state\",\n \"in\": \"query\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\",\n \"enum\": [\n \"open\",\n \"closed\"\n ]\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"Order count\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"integer\"\n }\n }\n }\n }\n }\n }\n },\n \"/legacy\": {\n \"get\": {\n \"responses\": {\n \"200\": {\n \"description\": \"Legacy\"\n }\n }\n }\n }\n }\n}",< "currentSpec": "{\n \"openapi\": \"3.1.2\",\n \"info\": {\n \"title\": \"Synthetic Orders API\",\n \"version\": \"2.0\"\n },\n \"paths\": {\n \"/orders\": {\n \"get\": {\n \"parameters\": [\n {\n \"name\": \"state\",\n \"in\": \"query\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\",\n \"enum\": [\n \"open\"\n ]\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"Order count\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"integer\"\n }\n }\n }\n }\n }\n }\n }\n }\n}"<}<EOF
# Run the Actor using an HTTP API# See the full API reference at https://docs.apify.com/api/v2$curl "https://api.apify.com/v2/actors/fluffy_ingot~openapi-change-preflight/runs?token=$API_TOKEN" \< -X POST \< -d @input.json \< -H 'Content-Type: application/json'Below, you can find a list of relevant HTTP API endpoints for calling the OpenAPI Change Preflight | API Contract Checks Actor. For this, you’ll need an Apify account. Replace <YOUR_API_TOKEN> in the URLs with your Apify API token, which you can find under API & Integrations in Apify Console. For details, see the API reference.
https://api.apify.com/v2/actors/fluffy_ingot~openapi-change-preflight/runs?token=<YOUR_API_TOKEN>Note: By adding the method=POST query parameter, this API endpoint can be called using a GET request and thus used in third-party webhooks. Please refer to our Run Actor API documentation.
https://api.apify.com/v2/actors/fluffy_ingot~openapi-change-preflight/run-sync-get-dataset-items?token=<YOUR_API_TOKEN>Note: This endpoint supports both POST and GET request methods. However, only the POST method allows you to pass input data. For more information, please refer to our Run Actor synchronously and get dataset items API documentation.
https://api.apify.com/v2/actors/fluffy_ingot~openapi-change-preflight?token=<YOUR_API_TOKEN>For more information, please refer to our Get Actor API documentation.
Actors can be used to scrape web pages, extract data, or automate browser tasks. Use the OpenAPI Change Preflight | API Contract Checks API programmatically via the Apify API.
You can choose from:
You can start OpenAPI Change Preflight | API Contract Checks with the Apify API by sending an HTTP POST request to the Run Actorendpoint. An Actor’s input and its content type can be passed as a payload of the POST request, and additional options can be specified using URL query parameters. The OpenAPI Change Preflight | API Contract Checks is identified within the API by its ID, which is the creator’s username and the name of the Actor.
When the OpenAPI Change Preflight | API Contract Checks run finishes you can list the data from its default dataset(storage) via the API or you can preview the data directly on Apify Console.