OpenAPI/Swagger spec summary API

Fetches an OpenAPI/Swagger JSON spec by URL and summarizes it: spec version, title, API version, server, path count, total operation count, a method histogram (GET/POST/...), operations-per-tag, and the declared security schemes with a requiresAuth flag. Works with OpenAPI 3.x and Swagger 2.0. Answers 'how big is this API', 'how many endpoints/operations does it expose', 'what auth does it use', 'what does this spec cover'.

Price$0.01per request

MethodPOST

Route/v1/dev/openapi-summary

StatusLive

MIME typeapplication/json

Rate limit60/minute

Cache86400s public

devopenapiswaggerapispecinventoryoperationsauth

API URLhttps://x402.hexl.dev/v1/dev/openapi-summary

Integration docs

Example request

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

Example response

{
  "specVersion": "3.0.4",
  "title": "Swagger Petstore - OpenAPI 3.0",
  "apiVersion": "1.0.27",
  "server": "/api/v3",
  "pathCount": 13,
  "operationCount": 19,
  "methodCounts": {
    "POST": 6,
    "PUT": 2,
    "GET": 8,
    "DELETE": 3
  },
  "operationsByTag": [
    {
      "tag": "pet",
      "count": 8
    },
    {
      "tag": "user",
      "count": 7
    },
    {
      "tag": "store",
      "count": 4
    }
  ],
  "authSchemes": [
    {
      "name": "petstore_auth",
      "type": "oauth2",
      "scheme": null
    },
    {
      "name": "api_key",
      "type": "apiKey",
      "scheme": null
    }
  ],
  "requiresAuth": true,
  "specUrl": "https://petstore3.swagger.io/api/v3/openapi.json"
}

Input schema

{
  "type": "object",
  "required": [
    "specUrl"
  ],
  "properties": {
    "specUrl": {
      "type": "string",
      "description": "Full http(s) URL to an OpenAPI/Swagger JSON spec."
    }
  }
}

Output schema

{
  "type": "object",
  "additionalProperties": true
}