# OpenAPI / Swagger Spec Audit (`conserving_mastodon/openapi-spec-audit`) Actor

Fetch an OpenAPI or Swagger spec (JSON or YAML) and get a graded A-F verdict: operation inventory, undocumented operations, missing responses and operationIds, security coverage, and duplicate operationIds. Charged only on completed audits.

- **URL**: https://apify.com/conserving\_mastodon/openapi-spec-audit.md
- **Developed by:** [Chris Arsenault](https://apify.com/conserving_mastodon) (community)
- **Categories:** Developer tools, Automation
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$250.00 / 1,000 completed audits

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?

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 / Swagger Spec Audit

**A quality grade for the machine interface.** Point it at an OpenAPI or Swagger spec (URL or inline, JSON or YAML) and get an A-F verdict with the specifics: how many operations, how many are undocumented, which lack responses or operationIds, what security schemes exist and how many operations skip them, and any duplicate operationIds that break code generation.

### What you get

Summary plus one row per operation:

```json
{
  "spec_type": "openapi", "spec_version": "3.0.4",
  "title": "Swagger Petstore", "grade": "A", "operations": 19,
  "undocumented_operations": 0, "security_schemes": ["petstore_auth", "api_key"],
  "unsecured_operations": 10,
  "fixes": ["10 operation(s) have no security applied."]
}
```

```json
{ "method": "POST", "path": "/pet", "operationId": "addPet",
  "summary": "Add a new pet to the store", "problems": [] }
```

### Use cases

- **API teams**: run in CI against your published spec; fail the build when documentation or security coverage regresses.
- **Agents and integrators evaluating an API**: know before you build whether the contract is complete, secured, and code-gen friendly.
- **Consultants**: an instant, evidence-backed quality read on a client's API surface.

### Honesty notes

- Validates structure and hygiene against the OpenAPI/Swagger shape; it is a completeness and quality audit, not a live conformance test against a running server.
- YAML and JSON specs are both accepted; a document that is neither, or has no `openapi`/`swagger` field, is rejected free.
- Fetching a spec is one polite GET; billing is per completed audit.

Built by 1450 Enterprises, alongside the MCP Server Probe and MCP Server Diff — the same "inventory a machine interface" idea, applied to REST.

# Actor input Schema

## `source` (type: `string`):

A URL to an OpenAPI/Swagger document (JSON or YAML), or the spec pasted inline.

## Actor input object example

```json
{
  "source": "https://petstore3.swagger.io/api/v3/openapi.json"
}
```

# Actor output Schema

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

Summary: spec type/version, grade, operation and path counts, documentation and security gaps, fix list. Then one row per operation with its problems.

# 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 = {
    "source": "https://petstore3.swagger.io/api/v3/openapi.json"
};

// Run the Actor and wait for it to finish
const run = await client.actor("conserving_mastodon/openapi-spec-audit").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 = { "source": "https://petstore3.swagger.io/api/v3/openapi.json" }

# Run the Actor and wait for it to finish
run = client.actor("conserving_mastodon/openapi-spec-audit").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 '{
  "source": "https://petstore3.swagger.io/api/v3/openapi.json"
}' |
apify call conserving_mastodon/openapi-spec-audit --silent --output-dataset

```

## MCP server setup

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

```

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/H9wndeysNpQ4zZCWo/builds/vRhkEebeeLOzU6yYD/openapi.json