OpenAPI Generator Schema Composition — allOf, oneOf, anyOf Composition Patterns

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

OpenAPI Generator schema composition uses allOf (extension/inheritance), oneOf (discriminated unions), and anyOf (flexible schemas) to model complex data relationships, with each composition type producing different generated code patterns.

What You'll Learn

• allOf for model inheritance and extension
• oneOf for discriminated unions
• anyOf for flexible schema matching
• Generator behavior differences
• Composition best practices

flowchart TD
    A["Schema Composition Types"] --> B["allOf: AND composition"]
    A --> C["oneOf: XOR (exactly one)"]
    A --> D["anyOf: OR (one or more)"]

    B --> B1["Generated: Class inheritance"]
    B --> B2["Base: Threat -> Extended: MalwareThreat"]

    C --> C1["Generated: Union types / sealed classes"]
    C --> C2["Discriminator enables proper type mapping"]

    D --> D1["Generated: Union (less strict)"]
    D --> D2["Harder to generate clean code"]
    D --> D3["Prefer oneOf with discriminator"]

What's Next

Apply composition patterns in {{< ilink "OpenAPI" "OpenAPI Generator Specification" }} and review {{< ilink "OpenAPI" "OpenAPI Generator Custom Types" }} for type mapping.