io.muserver.openapi

Class MediaTypeObjectBuilder

java.lang.Object

io.muserver.openapi.MediaTypeObjectBuilder

public class MediaTypeObjectBuilder
extends Object

Each Media Type Object provides schema and examples for the media type identified by its key.

Constructor Summary

Constructors

Constructor and Description
MediaTypeObjectBuilder()

Method Summary

Modifier and Type	Method and Description
MediaTypeObject	build()
static MediaTypeObjectBuilder	mediaTypeObject() Creates a builder for a MediaTypeObject
MediaTypeObjectBuilder	withEncoding(Map<String,EncodingObject> encoding)
MediaTypeObjectBuilder	withExample(Object example)
MediaTypeObjectBuilder	withExamples(Map<String,ExampleObject> examples)
MediaTypeObjectBuilder	withSchema(SchemaObject schema)

Methods inherited from class java.lang.Object

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

Constructor Detail

MediaTypeObjectBuilder

public MediaTypeObjectBuilder()

Method Detail

withSchema

public MediaTypeObjectBuilder withSchema(SchemaObject schema)

Parameters:

schema - The schema defining the type used for the request body.

Returns:

The current builder

withExample

public MediaTypeObjectBuilder withExample(Object example)

Parameters:

example - Example of the media type. The example object SHOULD be in the correct format as specified by the media type. The example field is mutually exclusive of the examples field.

Returns:

The current builder

withExamples

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

Parameters:

examples - Examples of the media type. Each example object SHOULD match the media type and specified schema if present. The examples field is mutually exclusive of the example field.

Returns:

The current builder

withEncoding

public MediaTypeObjectBuilder withEncoding(Map<String,EncodingObject> encoding)

Parameters:

encoding - A map between a property name and its encoding information. The key, being the property name, MUST exist in the schema as a property. The encoding object SHALL only apply to requestBody objects when the media type is multipart or application/x-www-form-urlencoded.

Returns:

The current builder

build

public MediaTypeObject build()

mediaTypeObject

public static MediaTypeObjectBuilder mediaTypeObject()

Creates a builder for a MediaTypeObject

Returns:

A new builder