io.muserver.openapi

Class ComponentsObjectBuilder

java.lang.Object

io.muserver.openapi.ComponentsObjectBuilder

public class ComponentsObjectBuilder
extends Object

Holds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.

Constructor Summary

Constructors

Constructor and Description
ComponentsObjectBuilder()

Method Summary

Modifier and Type	Method and Description
ComponentsObject	build()
static ComponentsObjectBuilder	componentsObject() Creates a builder for a ComponentsObject
ComponentsObjectBuilder	withCallbacks(Map<String,CallbackObject> callbacks)
ComponentsObjectBuilder	withExamples(Map<String,ExampleObject> examples)
ComponentsObjectBuilder	withHeaders(Map<String,HeaderObject> headers)
ComponentsObjectBuilder	withLinks(Map<String,LinkObject> links)
ComponentsObjectBuilder	withParameters(Map<String,ParameterObject> parameters)
ComponentsObjectBuilder	withRequestBodies(Map<String,RequestBodyObject> requestBodies)
ComponentsObjectBuilder	withResponses(Map<String,ResponseObject> responses)
ComponentsObjectBuilder	withSchemas(Map<String,SchemaObject> schemas)
ComponentsObjectBuilder	withSecuritySchemes(Map<String,SecuritySchemeObject> securitySchemes)

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentsObjectBuilder

public ComponentsObjectBuilder()

Method Detail

withSchemas

public ComponentsObjectBuilder withSchemas(Map<String,SchemaObject> schemas)

Parameters:

schemas - An object to hold reusable Schema Objects.

Returns:

The current builder

withResponses

public ComponentsObjectBuilder withResponses(Map<String,ResponseObject> responses)

Parameters:

responses - An object to hold reusable Response Objects.

Returns:

The current builder

withParameters

public ComponentsObjectBuilder withParameters(Map<String,ParameterObject> parameters)

Parameters:

parameters - An object to hold reusable Parameter Objects.

Returns:

The current builder

withExamples

public ComponentsObjectBuilder withExamples(Map<String,ExampleObject> examples)

Parameters:

examples - An object to hold reusable Example Objects.

Returns:

The current builder

withRequestBodies

public ComponentsObjectBuilder withRequestBodies(Map<String,RequestBodyObject> requestBodies)

Parameters:

requestBodies - An object to hold reusable Request Body Objects.

Returns:

The current builder

withHeaders

public ComponentsObjectBuilder withHeaders(Map<String,HeaderObject> headers)

Parameters:

headers - An object to hold reusable Header Objects.

Returns:

The current builder

withSecuritySchemes

public ComponentsObjectBuilder withSecuritySchemes(Map<String,SecuritySchemeObject> securitySchemes)

Parameters:

securitySchemes - An object to hold reusable Security Scheme Objects.

Returns:

The current builder

withLinks

public ComponentsObjectBuilder withLinks(Map<String,LinkObject> links)

Parameters:

links - An object to hold reusable Link Objects.

Returns:

The current builder

withCallbacks

public ComponentsObjectBuilder withCallbacks(Map<String,CallbackObject> callbacks)

Parameters:

callbacks - An object to hold reusable Callback Objects.

Returns:

The current builder

build

public ComponentsObject build()

componentsObject

public static ComponentsObjectBuilder componentsObject()

Creates a builder for a ComponentsObject

Returns:

A new builder