Builder

Builder for the OpenAPI root document object.

This does not include builder DSL for path items and webhooks. These are generally handled on the routes themselves, then resolved later at runtime.

Constructors

constructor()

open override var components: Components?

Optional reusable components for the document (schemas, responses, parameters, request bodies, etc.).

Specification extensions for the document.

Optional external documentation for the entire API.

open override var info: OpenApiInfo

Required OpenAPI "Info Object" describing the API (title, version, optional description, etc.).

OpenAPI specification version to be written into the resulting document.

A list of security requirements configured for this API.

A list of servers configured for this API.

Builds an instance of OpenApiDoc based on the current state of the Builder.

inline fun <T : Any> extension(name: String, value: T)

Adds a specification-extension to this OpenAPI document.

open override fun security(configure: Security.Builder.() -> Unit)

Configures one or more global security requirements using the Security DSL.

open override fun servers(configure: Servers.Builder.() -> Unit)

Configures one or more servers for this API using the Servers DSL.

open override fun tag(tag: String)

Registers a tag name at the document level.