Package io.muserver.openapi

Class RequestBodyObjectBuilder

  • public class RequestBodyObjectBuilder
extends java.lang.Object
    Describes a single request body.

    • Constructor Detail

      • RequestBodyObjectBuilder

        public RequestBodyObjectBuilder()

    • Method Detail

      • withDescription

        public RequestBodyObjectBuilder withDescription​(java.lang.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​(java.util.Map<java.lang.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​(java.lang.Boolean required)
        Parameters:
        required - Determines if the request body is required in the request. Defaults to false.
        Returns:
        The current builder