ktor-openapi-schema/io.ktor.openapi/Server

Server

@Serializable(with = Server.Companion.Serializer::class)

data class Server(val url: String, val description: String? = null, val extensions: ExtensionProperties? = null) : Extensible(source)

Describes a server that hosts the API.

Report a problem

Constructors

constructor(url: String, description: String? = null, extensions: ExtensionProperties? = null)

Types

Builder for constructing a Server definition.

object Companion

Properties

val description: String?

Optional description of the server.

open override val extensions: ExtensionProperties?

Specification-extensions for this server (keys must start with x-).

val url: String

The URL of the target host.