OpenApiDocDsl

A small interface exposing the OpenAPI document builder state.

This is used in the OpenAPI and Swagger plugins for providing details in the resulting generated document.

Properties

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

Specification extensions for the document.

Optional external documentation for the entire API.

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

OpenAPI specification version to be written into the resulting document.

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

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

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

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

abstract fun tag(tag: String)

Registers a tag name at the document level.