# OpenAPI Response Validator (`junipr/openapi-response-validator`) Actor

Validate live or supplied API responses against an OpenAPI operation’s expected response schema and return endpoint-level pass/fail evidence.

- **URL**: https://apify.com/junipr/openapi-response-validator.md
- **Developed by:** [junipr](https://apify.com/junipr) (community)
- **Categories:** SEO tools, Developer tools, E-commerce
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $6.50 / 1,000 schema validateds

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## OpenAPI Response Validator

### Store Positioning

**Store title:** OpenAPI Response Validator

**Short description:** Validate live or supplied API responses against an OpenAPI operation’s expected response schema and return endpoint-level pass/fail evidence.

**SEO title:** OpenAPI Response Validator — API, schema, and developer QA

**SEO description:** Validate live or supplied API responses against an OpenAPI operation’s expected response schema and return endpoint-level pass/fail evidence. Use it to catch contract drift, schema mistakes, unsafe endpoint assumptions, and developer-tool quality issues before release.

**Categories:** SEO\_TOOLS, DEVELOPER\_TOOLS, ECOMMERCE

**Keywords:** openapi, response, validator, schema, api testing, api/developer qa

### Pay-Per-Event Pricing

This actor uses pay-per-event pricing. Event prices include Apify platform usage; users are not expected to pay a separate platform-usage pass-through charge for the configured pricing model.

- Tier: A1 — API/developer QA
- Primary event: `schema-validated` at $0.00650 base
- Default max charge: $10.00
- Store discounts: FREE/BRONZE base, SILVER discounted, GOLD deepest approved discount

Event set:

- `actor-start`: base $0.00500, GOLD $0.00400. Openapi Response Validator: charged when actor start is completed. The price includes Apify platform usage; no separate usage pass-through is intended.
- `schema-validated`: base $0.00650, GOLD $0.00520. Openapi Response Validator: charged when schema validated is completed. The price includes Apify platform usage; no separate usage pass-through is intended.
- `contract-rule-checked`: base $0.00390, GOLD $0.00312. Openapi Response Validator: charged when contract rule checked is completed. The price includes Apify platform usage; no separate usage pass-through is intended.
- `report-generated`: base $0.05000, GOLD $0.04000. Openapi Response Validator: charged when report generated is completed. The price includes Apify platform usage; no separate usage pass-through is intended.

The actor accepts `actor-start` before work, accepts the primary event before each dataset row, and accepts `report-generated` before writing report files. If `maxChargeUsd` or the live PPE limit blocks a charge, the corresponding row or report is not written.

### Public Task Concepts

- Validate OpenAPI Response records from a capped sample
- Find invalid OpenAPI Response values before delivery
- Check OpenAPI Response coverage against expected rules
- Prioritize OpenAPI Response validation failures by severity
- Export OpenAPI Response pass-fail rows with evidence
  Validate response samples against OpenAPI operation/status schemas.

### What It Does

Parses OpenAPI 3.x JSON, resolves local $ref schemas, and validates required fields, types, enums, nullable values, arrays, and objects.

### Inputs

This actor exposes these input fields in `.actor/input_schema.json`:

- `openapiSpecUrl`
- `openapiSpecJson`
- `operationIds`
- `responseSamples`
- `baseUrl`
- `headers`
- `allowedMethods`
- `maxOperations`
- `timeoutMs`
- `validateExamplesOnly`
- `skipUnsafeMethods`
- `maxChargeUsd`

The exact default fetches the public Swagger Petstore OpenAPI document and validates a bounded supplied inventory response against the documented schema. This keeps the automated first run deterministic while exercising the production validation path.

### Outputs

Dataset rows contain:

- `operationId`
- `method`
- `path`
- `statusCode`
- `schemaFound`
- `responseValid`
- `errorPath`
- `errorKeyword`
- `expectedType`
- `actualValue`
- `message`
- `recommendation`

Sample outputs in `examples/output.sample.json` and `output.sample.json` were generated from `examples/input.tiny.json` through actor logic.

### Reports

After the `report-generated` charge is accepted, the actor writes its Markdown, JSON, or CSV reports to the key-value store. A rejected report charge leaves those files unwritten.

### Public Task Concepts

- Validate OpenAPI Response Validator before release
- Run a bounded OpenAPI Response Validator QA check
- Generate developer QA evidence for OpenAPI Response Validator

### Safe use

Use small capped runs first. Network paths are bounded; review output quality and costs before increasing limits.

# Actor input Schema

## `openapiSpecUrl` (type: `string`):

URL to an OpenAPI JSON or YAML document to validate against.

## `openapiSpecJson` (type: `object`):

Inline OpenAPI document object to use instead of fetching a spec URL.

## `operationIds` (type: `array`):

Operation IDs to include in the validation run. Leave empty to inspect eligible operations up to the configured cap.

## `responseSamples` (type: `array`):

API response samples to validate against the matching OpenAPI response schemas.

## `baseUrl` (type: `string`):

Base API URL used when validating response samples against an OpenAPI operation.

## `headers` (type: `object`):

Optional request headers for authorized endpoints. Avoid secrets in shared examples and public tasks.

## `allowedMethods` (type: `array`):

Allowed methods for this run. Values outside this list are skipped or flagged.

## `maxOperations` (type: `number`):

Maximum operations to process in one run; keep defaults low for safe first runs.

## `timeoutMs` (type: `number`):

Maximum time in milliseconds allowed for the OpenAPI Response Validator operation before it is treated as timed out.

## `validateExamplesOnly` (type: `boolean`):

Validate Examples Only controls OpenAPI Response Validator processing for the supplied inputs; keep values conservative for first runs.

## `skipUnsafeMethods` (type: `boolean`):

Skip Unsafe Methods controls OpenAPI Response Validator processing for the supplied inputs; keep values conservative for first runs.

## `maxChargeUsd` (type: `number`):

Maximum estimated PPE charge allowed for the run before the actor stops gracefully.

## Actor input object example

```json
{
  "openapiSpecUrl": "https://petstore3.swagger.io/api/v3/openapi.json",
  "operationIds": [
    "getInventory"
  ],
  "responseSamples": [
    {
      "operationId": "getInventory",
      "method": "GET",
      "path": "/store/inventory",
      "statusCode": 200,
      "body": {
        "available": 12,
        "pending": 3
      }
    }
  ],
  "baseUrl": "https://petstore3.swagger.io/api/v3/",
  "headers": {},
  "allowedMethods": [
    "GET"
  ],
  "maxOperations": 1,
  "timeoutMs": 10000,
  "validateExamplesOnly": true,
  "skipUnsafeMethods": true,
  "maxChargeUsd": 1
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("junipr/openapi-response-validator").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("junipr/openapi-response-validator").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call junipr/openapi-response-validator --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=junipr/openapi-response-validator",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/acts/N6Grkjpod2Br5xWcF/builds/XBpdhrfa4jV2pvIcm/openapi.json