Merge OpenAPI

Merge multiple OpenAPI documents into one reviewable API description.

freeworks offlinenothing uploaded
ToolOpenAPI Merger
Input
Output
—

How it works

Documents are parsed and merged by paths, operations, components, tags, and servers; conflicts use selected precedence or are reported. Local references remain local unless explicitly rewritten.

  • Component maps support split service specs.
  • Conflict reporting prevents silent replacement.

Worked example

Merge Users and Posts APIs
Combine two separate OpenAPI specs into a single unified specification
Input
											Input1: {"openapi":"3.0.3","info":{"title":"Users API","version":"1.0.0"},"paths":{"/users":{"get":{"summary":"List users"}}}}
Input2: {"openapi":"3.0.3","info":{"title":"Posts API","version":"1.0.0"},"paths":{"/posts":{"get":{"summary":"List posts"}}}}
Output
												{
  "openapi": "3.0.3",
  "info": {
    "title": "Users API + Posts API",
    "version": "1.0.0",
    "description": ""
  },
  "paths": {
    "/users": {
      "get": {
        "summary": "List users"
      }
    },
    "/posts": {
      "get": {
        "summary": "List posts"
      }
    }
  }
}

When to use this

API gateways, developer portals, and shared service specs merge OpenAPI documents.

Edge cases

  • Two operations can disagree on parameters or responses.
  • A local $ref can break when its source document is removed.
  • Same-named security schemes can have different definitions.

References