SchemaExampleValueGenerator

class SchemaExampleValueGenerator(valueProviders: List<SchemaValueProvider>, schemaMerger: SchemaMerger = SchemaMerger(), options: SchemaExampleValueGeneratorOptions = SchemaExampleValueGeneratorOptions())

Generates synthetic example values from OpenAPI schemas for use in tests.

Provider order matters: the first provider that returns a non-null value wins.

Constructors

constructor(valueProviders: List<SchemaValueProvider>, schemaMerger: SchemaMerger = SchemaMerger(), options: SchemaExampleValueGeneratorOptions = SchemaExampleValueGeneratorOptions())

fun getExampleArrayValues(name: String, schema: Schema<*>, openAPI: OpenAPI): List<Any>

Produces an example array value that satisfies array constraints.

fun getExampleArrayValuesByItem(name: String, arraySchema: Schema<*>, itemSchema: Schema<*>, openAPI: OpenAPI, depth: Int = 0, visitedRefs: MutableSet<String> = mutableSetOf()): List<Any>

Produces an example array value from explicit array and item schemas.

fun getExampleObject(name: String, schema: Schema<*>, openAPI: OpenAPI): Map<String, Any>

Generates a valid object based on the provided schema.

fun getExampleValue(name: String, schema: Schema<*>, openAPI: OpenAPI, variationIndex: Int = 0): Any

Retrieves the example value for a given parameter based on its schema.

fun getExampleValueWithOptions(name: String, schema: Schema<*>, openAPI: OpenAPI, options: SchemaExampleValueGeneratorOptions, variationIndex: Int = 0): Any

Retrieves the example value with custom options for per-call customization.