io.muserver.openapi

Class InfoObjectBuilder

java.lang.Object

io.muserver.openapi.InfoObjectBuilder

public class InfoObjectBuilder
extends Object

The object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.

Constructor Summary

Constructors

Constructor and Description
InfoObjectBuilder()

Method Summary

Modifier and Type	Method and Description
InfoObject	build()
static InfoObjectBuilder	infoObject() Creates a builder for a InfoObject
InfoObjectBuilder	withContact(ContactObject contact)
InfoObjectBuilder	withDescription(String description)
InfoObjectBuilder	withLicense(LicenseObject license)
InfoObjectBuilder	withTermsOfService(URI termsOfService)
InfoObjectBuilder	withTitle(String title)
InfoObjectBuilder	withVersion(String version)

Methods inherited from class java.lang.Object

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

Constructor Detail

InfoObjectBuilder

public InfoObjectBuilder()

Method Detail

withTitle

public InfoObjectBuilder withTitle(String title)

Parameters:

title - REQUIRED. The title of the application. Default value is API Documentation

Returns:

The current builder

withDescription

public InfoObjectBuilder withDescription(String description)

Parameters:

description - A short description of the application. CommonMark syntax MAY be used for rich text representation.

Returns:

The current builder

withTermsOfService

public InfoObjectBuilder withTermsOfService(URI termsOfService)

Parameters:

termsOfService - A URL to the Terms of Service for the API.

Returns:

The current builder

withContact

public InfoObjectBuilder withContact(ContactObject contact)

Parameters:

contact - The contact information for the exposed API.

Returns:

The current builder

withLicense

public InfoObjectBuilder withLicense(LicenseObject license)

Parameters:

license - The license information for the exposed API.

Returns:

The current builder

withVersion

public InfoObjectBuilder withVersion(String version)

Parameters:

version - REQUIRED. The version of the OpenAPI document. Default value is 1.0

Returns:

The current builder

build

public InfoObject build()

infoObject

public static InfoObjectBuilder infoObject()

Creates a builder for a InfoObject

Returns:

A new builder