Package org.apache.juneau.bean.openapi3

Class RequestBodyInfo

java.lang.Object
org.apache.juneau.bean.openapi3.OpenApiElement
org.apache.juneau.bean.openapi3.RequestBodyInfo
public class RequestBodyInfo extends OpenApiElement
Describes a single request body.

The Request Body Object describes a single request body that can be sent to an API operation. It includes a description, whether the request body is required, and the content (media types) that the request body can contain.

OpenAPI Specification:

The Request Body Object is composed of the following fields:

  • description (string) - A brief description of the request body (CommonMark syntax may be used)
  • content (map of MediaType, REQUIRED) - The content of the request body (keys are media types)
  • required (boolean) - Determines if the request body is required in the request (default is false)
Example:

// Create a request body for JSON content RequestBodyInfo requestBody = new RequestBodyInfo() .setDescription("Pet object that needs to be added to the store") .setRequired(true) .setContent( JsonMap.of( "application/json", new MediaType() .setSchema( new SchemaInfo().setRef("#/components/schemas/Pet") ) ) );

See Also:

  • Constructor Details

  • Method Details

    • addContent

      public RequestBodyInfo addContent(String key, MediaType value)
      Adds one or more values to the content property.
      Parameters:
      key - The mapping key. Must not be null, or an IllegalArgumentException is thrown.
      value - The values to add to this property.
      Must not be null, or an IllegalArgumentException is thrown.
      Ignored if null.
      Returns:
      This object

    • copy

      public RequestBodyInfo copy()
      Make a deep copy of this object.
      Returns:
      A deep copy of this object.

    • get

      public <T> T get(String property, Class<T> type)
      Description copied from class: OpenApiElement
      Generic property getter.

      Can be used to retrieve non-standard Swagger fields such as "$ref".

      Overrides:
      get in class OpenApiElement
      Type Parameters:
      T - The datatype to cast the value to.
      Parameters:
      property - The property name to retrieve.
      type - The datatype to cast the value to.
      Returns:
      The property value, or null if the property does not exist or is not set.

    • getContent

      public Map<String,MediaType> getContent()
      Bean property getter: content.
      Returns:
      The property value, or null if it is not set.

    • getDescription

      public String getDescription()
      Bean property getter: description.

      A brief description of the request body.

      Returns:
      The property value, or null if it is not set.

    • getRequired

      public Boolean getRequired()
      Bean property getter: required.

      Determines if the request body is required in the request.

      Returns:
      The property value, or null if it is not set.

    • keySet

      public Set<String> keySet()
      Description copied from class: OpenApiElement
      Returns all the keys on this element.
      Overrides:
      keySet in class OpenApiElement
      Returns:
      All the keys on this element.
      Never null.

    • set

      public RequestBodyInfo set(String property, Object value)
      Description copied from class: OpenApiElement
      Generic property setter.

      Can be used to set non-standard Swagger fields such as "$ref".

      Overrides:
      set in class OpenApiElement
      Parameters:
      property - The property name to set. Must not be null, or an IllegalArgumentException is thrown.
      value - The new value for the property.
      Returns:
      This object

    • setContent

      public RequestBodyInfo setContent(Map<String,MediaType> value)
      Bean property setter: content.
      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • setDescription

      public RequestBodyInfo setDescription(String value)
      Bean property setter: description.

      A brief description of the request body.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • setRequired

      public RequestBodyInfo setRequired(Boolean value)
      Bean property setter: required.

      Determines if the request body is required in the request.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • strict

      public RequestBodyInfo strict(Object value)
      Description copied from class: OpenApiElement
      Sets strict mode on this bean.
      Overrides:
      strict in class OpenApiElement
      Parameters:
      value - The new value for this property.
      Non-boolean values will be converted to boolean using Boolean.valueOf(value.toString()).
      Can be null (interpreted as false).
      Returns:
      This object

    • strict

      protected RequestBodyInfo strict()
      Description copied from class: OpenApiElement
      Sets strict mode on this bean.
      Overrides:
      strict in class OpenApiElement
      Returns:
      This object