org.springdoc.core.fn.builders.externaldocumentation

Class Builder

java.lang.Object

org.springdoc.core.fn.builders.externaldocumentation.Builder

public class Builder
extends Object

The type External documentation builder.

Author:

bnasslahsen

Method Summary

Modifier and Type	Method and Description
io.swagger.v3.oas.annotations.ExternalDocumentation	build() Build external documentation.
Builder	description(String description) Description external documentation builder.
Builder	extension(Builder extensionBuilder) Extensions external documentation builder.
static Builder	externalDocumentationBuilder() An external documentation external documentation builder.
Builder	url(String url) Url external documentation builder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

externalDocumentationBuilder

public static Builder externalDocumentationBuilder()

An external documentation external documentation builder.

Returns:

the external documentation builder

description

public Builder description(String description)

Description external documentation builder.

Parameters:

description - the description

Returns:

the external documentation builder

url

public Builder url(String url)

Url external documentation builder.

Parameters:

url - the url

Returns:

the external documentation builder

extension

public Builder extension(Builder extensionBuilder)

Extensions external documentation builder.

Parameters:

extensionBuilder - the extensions

Returns:

the external documentation builder

build

public io.swagger.v3.oas.annotations.ExternalDocumentation build()

Build external documentation.

Returns:

the external documentation