# OpenAPI & Swagger Validator and Endpoint Extractor (`catblik/openapi-validator`) Actor

Validate inline OpenAPI 3.0, 3.1 and Swagger 2.0 JSON specifications and extract endpoint inventories without fetching external references.

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

## Pricing

from $2.00 / 1,000 specification 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/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
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.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## 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.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## OpenAPI & Swagger Validator and Endpoint Extractor

Validate OpenAPI 3.0.x, 3.1.x and Swagger 2.0 specifications in bulk and get a clean JSON report: valid or not, the exact errors, and a list of every endpoint (method, path, operationId). Use it in CI pipelines, API catalog checks, AI-agent tool pipelines, or before importing a spec into a gateway or SDK generator.

It works fully offline on the spec you send: no requests to your API, no external `$ref` fetching, no login or proxies. It uses the `openapi-spec-validator` library.

### What you get

- Validity check against the OpenAPI / Swagger schema (`valid: true/false`)
- Up to 50 readable error messages per spec for invalid documents
- Spec version and API title
- Endpoint inventory: HTTP method, path, operationId (up to 1,000 operations)
- Safe handling of bad input: unsupported or unsafe documents return `status: rejected` with a reason, and are not charged

### Example input

```json
{
  "documents": [
    {
      "openapi": "3.0.3",
      "info": { "title": "Health API", "version": "1.0" },
      "paths": {
        "/health": {
          "get": {
            "operationId": "health",
            "responses": { "200": { "description": "OK" } }
          }
        }
      }
    }
  ]
}
```

Supply 1–20 documents. Each must be an inline JSON object, at most 1 MB. YAML text and URL inputs are not supported: convert YAML to JSON and inline external references first.

### Example output

```json
{
  "index": 0,
  "status": "validated",
  "version": "3.0.3",
  "title": "Health API",
  "valid": true,
  "errors": [],
  "errorsTruncated": false,
  "operationCount": 1,
  "operations": [{ "method": "GET", "path": "/health", "operationId": "health" }],
  "operationsTruncated": false
}
```

An invalid spec (for example, a missing `responses` object) is still a successful run: you get `valid: false` and the list of errors to fix.

### Pricing

$0.002 per specification checked ($2 per 1,000), including invalid specifications. Rejected inputs are not charged the spec event. Apify platform start and dataset charges may also apply, shown on the pricing page.

### Limits

Validation checks the specification itself, not the running API or response correctness. Only ordinary operations directly under `paths` are inventoried; callbacks and webhooks are not expanded. External `$ref` / `$dynamicRef` values (file, relative or URL) are rejected; broken internal references give an invalid report. Do not upload confidential specifications you are not allowed to share.

### FAQ

**Can it validate a Swagger 2.0 file?** Yes, 2.0, 3.0.x and 3.1.x.
**Can I pass a URL?** Not yet; send the JSON content.
**Does it call my API?** No. Processing is offline.

### Local use

Install requirements, then run `python -m src.main` with Apify local input storage. Tests: `python -m unittest discover -s tests -v`.

# Actor input Schema

## `documents` (type: `array`):

1 to 20 inline JSON specifications, each at most 1 MB. External references are rejected.

## Actor input object example

```json
{
  "documents": [
    {
      "openapi": "3.0.3",
      "info": {
        "title": "Health API",
        "version": "1.0"
      },
      "paths": {
        "/health": {
          "get": {
            "operationId": "health",
            "responses": {
              "200": {
                "description": "OK"
              }
            }
          }
        }
      }
    }
  ]
}
```

# Actor output Schema

## `results` (type: `string`):

No description

# 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 = {
    "documents": [
        {
            "openapi": "3.0.3",
            "info": {
                "title": "Health API",
                "version": "1.0"
            },
            "paths": {
                "/health": {
                    "get": {
                        "operationId": "health",
                        "responses": {
                            "200": {
                                "description": "OK"
                            }
                        }
                    }
                }
            }
        }
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("catblik/openapi-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 = { "documents": [{
            "openapi": "3.0.3",
            "info": {
                "title": "Health API",
                "version": "1.0",
            },
            "paths": { "/health": { "get": {
                        "operationId": "health",
                        "responses": { "200": { "description": "OK" } },
                    } } },
        }] }

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

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

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

```

## CLI example

```bash
echo '{
  "documents": [
    {
      "openapi": "3.0.3",
      "info": {
        "title": "Health API",
        "version": "1.0"
      },
      "paths": {
        "/health": {
          "get": {
            "operationId": "health",
            "responses": {
              "200": {
                "description": "OK"
              }
            }
          }
        }
      }
    }
  ]
}' |
apify call catblik/openapi-validator --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,catblik/openapi-validator"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/YhTHel8TnpabK08UF/builds/6narVA4vQ7estkTzY/openapi.json