OpenAPI Operation ID Checker

How to use this developer tool

1. Paste a JSON-formatted API document or load the included sample.
2. Check that the document shape matches the label above the editor.
3. Select “Check Operation IDs” or press Ctrl/Cmd + Enter.
4. Review the summary and download the copy-ready result.

What this developer tool does

Each HTTP operation is checked for presence, uniqueness, and a conservative identifier pattern suitable for generated method names.

A clean result means the local identifier rules passed; it is not a full OpenAPI validation.

Example

The Sample button loads a small specification chosen for this operation. Running it produces the same structured fields shown in the output panel.

{
  "openapi": "3.0.3",
  "info": {
    "title": "Orders",
    "version": "1"
  },
  "paths": {
    "/orders": {
      "get": {
        "operationId": "listOrders",
        "responses": {}
      },
      "post": {
        "operationId": "listOrders",
        "responses": {}
      }
    },
    "/orders/{id}": {
      "get": {
        "responses": {}
      }
    }
  }
}

Use cases

• Review an API contract during a pull request.
• Prepare documentation or deterministic test fixtures.
• Find migration work before changing generators or clients.
• Export a focused report without sharing the source document.

Tips for reliable output

• Bundle remote references before running the page.
• Keep operation IDs stable across published versions.
• Prefer explicit examples for domain-specific values.
• Validate the complete document after applying generated output.
• Commit the original specification before a conversion.

Processing details

The checker builds an index of operationId values, records every location, then emits missing, invalid, and duplicate findings in path order.

Generator-specific reserved words are not checked. External references and YAML input are outside this browser-only audit.