#286 · Developer Tool

OpenAPI Parameter Table Builder

Flatten OpenAPI parameters into a reviewable table without losing their operation or location. Path-level parameters are merged with operation-level declarations, while an operation-level parameter with the same name and in value takes precedence. The table reports method, route, name, location, required status, type, format, default, and description. It is suited to endpoint documentation, coverage checks, and spreadsheet handoffs where nested JSON is inconvenient.

Developer Input

OpenAPI JSON
Ad space

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 “Build Parameter Table” or press Ctrl/Cmd + Enter.
  4. Review the summary and download the copy-ready result.

What this developer tool does

The builder converts reusable and inline parameter definitions into one tab-separated row per operation parameter.

Parameters are keyed by the pair of name and location. Operation-level definitions override matching path-level definitions as required by OpenAPI.

Request bodies are not parameters and therefore do not appear in this table.

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": "Search",
    "version": "1"
  },
  "paths": {
    "/search": {
      "parameters": [
        {
          "name": "locale",
          "in": "header",
          "schema": {
            "type": "string"
          }
        }
      ],
      "get": {
        "operationId": "search",
        "parameters": [
          {
            "name": "q",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 20
            }
    
…

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

Local parameter references are resolved before fields are read. Array types and basic schema formats are preserved in their own columns.

Serialization styles are not expanded into example query strings. External references and Swagger 2 body parameters are outside scope.

Frequently asked questions

Does this page accept YAML OpenAPI files?

No. This browser-only implementation accepts JSON so parsing behavior stays predictable without loading an external YAML library. Convert YAML to JSON first.

Are external $ref URLs resolved?

No. Local JSON Pointer references are handled where the operation needs them, but remote references are not fetched.

Does the result replace a full OpenAPI validator?

No. OpenAPI Parameter Table Builder performs its documented transformation or audit. Use a standards-aware validator before publishing a specification.

Is the specification uploaded to a server?

No. Processing runs in the current browser tab. The page does not send the pasted document to an API.

Can I download the result?

Yes. Run the tool, then use Download for the primary output or the JSON and CSV buttons when those structured exports are available.

Input contract

ItemRequirement
FormatJSON object
ExecutionLocal browser
Remote refsNot fetched

API & GraphQL Tools

Browse contract inspection, conversion, request, response, and schema utilities.

Open category hub