OpenAPI Generator Mono-Repo — Managing Multi-Spec Generation in Monorepo Structures

In this tutorial, you will learn about OpenAPI Generator Mono. We cover key concepts, practical examples, and best practices to help you master this topic.

OpenAPI Generator mono-repo manages multiple API specifications within a single Repository, sharing schemas across specs, coordinating versioning, and generating SDKs for all services efficiently.

flowchart LR
    subgraph "Monorepo Structure"
    A["apis/"]
    B["apis/threats/openapi.yaml"]
    C["apis/reports/openapi.yaml"]
    D["apis/indicators/openapi.yaml"]
    E["shared/schemas/"]
    F["shared/parameters/"]
    G["shared/responses/"]
    end

    B -->|"$ref"| E
    C -->|"$ref"| E
    D -->|"$ref"| E
    B -->|"$ref"| F
    B -->|"$ref"| G

    H["CI Pipeline"] --> I["Detect changed specs"]
    I --> J["Generate only changed services"]
    J --> K["Publish service SDKs"]

What's Next

Organize your Monorepo following {{< ilink "OpenAPI" "OpenAPI Generator Multi-File Specs" }} and automate with {{< ilink "OpenAPI" "OpenAPI Generator CI/CD" }}.