ktor-openapi/io.github.smiley4.ktoropenapi.config/ExampleConfig

ExampleConfig

class ExampleConfig

Configuration for examples

Properties

exampleEncoder

var exampleEncoder: GenericExampleEncoder

The GenericExampleEncoder responsible for encoding all example values.

Functions

encoder

fun encoder(exampleEncoder: GenericExampleEncoder)

Specify a custom encoder for example objects

example

fun example(example: ExampleDescriptor)

Add a shared example that can be referenced by all routes. The name of the example has to be unique among all shared examples and acts as its id.

fun example(name: String, example: Example)

fun example(name: String, example: ValueExampleDescriptorConfig.() -> Unit)

Add a shared example that can be referenced by all routes by the given name. The provided name has to be unique among all shared examples and acts as its id.