io.muserver.openapi

Class RequestBodyObjectBuilder

java.lang.Object

io.muserver.openapi.RequestBodyObjectBuilder

public class RequestBodyObjectBuilder
extends Object

Describes a single request body.

Constructor Summary

Constructors

Constructor and Description
RequestBodyObjectBuilder()

Method Summary

Modifier and Type	Method and Description
RequestBodyObject	build()
static RequestBodyObjectBuilder	requestBodyObject() Creates a builder for a RequestBodyObject
RequestBodyObjectBuilder	withContent(Map<String,MediaTypeObject> content)
RequestBodyObjectBuilder	withDescription(String description)
RequestBodyObjectBuilder	withRequired(boolean required)

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestBodyObjectBuilder

public RequestBodyObjectBuilder()

Method Detail

withDescription

public RequestBodyObjectBuilder withDescription(String description)

Parameters:

description - A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.

Returns:

The current builder

withContent

public RequestBodyObjectBuilder withContent(Map<String,MediaTypeObject> content)

Parameters:

content - REQUIRED. The content of the request body. The key is a media type or media type range and the value describes it. For requests that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*

Returns:

The current builder

withRequired

public RequestBodyObjectBuilder withRequired(boolean required)

Parameters:

required - Determines if the request body is required in the request. Defaults to false.

Returns:

The current builder

build

public RequestBodyObject build()

requestBodyObject

public static RequestBodyObjectBuilder requestBodyObject()

Creates a builder for a RequestBodyObject

Returns:

A new builder