Package org.apache.juneau.bean.swagger

Class ResponseInfo

java.lang.Object
org.apache.juneau.bean.swagger.SwaggerElement
org.apache.juneau.bean.swagger.ResponseInfo
public class ResponseInfo extends SwaggerElement
Describes a single response from an API operation.

The Response Object describes a single response from a Swagger 2.0 API operation, including a description, schema, headers, and examples. Responses are associated with HTTP status codes (e.g., 200, 404, 500).

Swagger Specification:

The Response Object is composed of the following fields:

  • description (string, REQUIRED) - A short description of the response
  • schema (SchemaInfo) - A definition of the response structure
  • headers (map of HeaderInfo) - Maps a header name to its definition
  • examples (map of any) - An example of the response message (keys are media types)
Example:

// Construct using SwaggerBuilder. ResponseInfo info = responseInfo("A complex object array response") .schema( schemaInfo .type("array") .items( items() .set("$ref", "#/definitions/VeryComplexType") ) ); // Serialize using JsonSerializer. String json = Json.from(info); // Or just use toString() which does the same as above. json = info.toString();

// Output { "description": "A complex object array response", "schema": { "type": "array", "items": { "$ref": "#/definitions/VeryComplexType" } } }

See Also:

  • Constructor Details

  • Method Details

    • copy

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

    • copyFrom

      public ResponseInfo copyFrom(ResponseInfo r)
      Copies any non-null fields from the specified object to this object.
      Parameters:
      r - The object to copy fields from.
      Can be null.
      Returns:
      This object.

    • getDescription

      public String getDescription()
      Bean property getter: description.

      A short description of the response.

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

    • setDescription

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

      A short description of the response.

      Parameters:
      value - The new value for this property.
      GFM syntax can be used for rich text representation.
      Property value is required.
      Can be null to unset the property.
      Returns:
      This object.

    • getExamples

      public Map<String,Object> getExamples()
      Bean property getter: examples.

      An example of the response message.

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

    • setExamples

      public ResponseInfo setExamples(Map<String,Object> value)
      Bean property setter: examples.

      An example of the response message.

      Parameters:
      value - The new value for this property.
      Keys must be MIME-type strings.
      Can be null to unset the property.
      Returns:
      This object.

    • addExample

      public ResponseInfo addExample(String mimeType, Object example)
      Bean property appender: examples.

      Adds a single value to the examples property.

      Parameters:
      mimeType - The mime-type string. Must not be null.
      example - The example. Must not be null.
      Returns:
      This object.

    • getHeaders

      public Map<String,HeaderInfo> getHeaders()
      Bean property getter: headers.

      A list of headers that are sent with the response.

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

    • setHeaders

      public ResponseInfo setHeaders(Map<String,HeaderInfo> value)
      Bean property setter: headers.

      A list of headers that are sent with the response.

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

    • addHeader

      public ResponseInfo addHeader(String name, HeaderInfo header)
      Bean property appender: headers.
      Parameters:
      name - The header name. Must not be null.
      header - The header descriptions Must not be null.
      Returns:
      This object.

    • getHeader

      public HeaderInfo getHeader(String name)
      Returns the header information with the specified name.
      Parameters:
      name - The header name. Must not be null.
      Returns:
      The header info, or null if not found.

    • getSchema

      public SchemaInfo getSchema()
      Bean property getter: schema.

      A definition of the response structure.

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

    • setSchema

      public ResponseInfo setSchema(SchemaInfo value)
      Bean property setter: schema.

      A definition of the response structure.

      Parameters:
      value - The new value for this property.
      It can be a primitive, an array or an object.
      Can be null to unset the property.
      Returns:
      This object.

    • get

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

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

      Overrides:
      get in class SwaggerElement
      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.

    • set

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

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

      Overrides:
      set in class SwaggerElement
      Parameters:
      property - The property name to set. Must not be null.
      value - The new value for the property.
      Returns:
      This object.

    • keySet

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

    • resolveRefs

      public ResponseInfo resolveRefs(Swagger swagger, Deque<String> refStack, int maxDepth)
      Resolves any "$ref" attributes in this element.
      Parameters:
      swagger - The swagger document containing the definitions.
      refStack - Keeps track of previously-visited references so that we don't cause recursive loops.
      maxDepth - The maximum depth to resolve references.
      After that level is reached, $ref references will be left alone.
      Useful if you have very complex models and you don't want your swagger page to be overly-complex.
      Returns:
      This object with references resolved.
      May or may not be the same object.

    • strict

      public ResponseInfo strict()
      Sets strict mode on this bean.
      Overrides:
      strict in class SwaggerElement
      Returns:
      This object.

    • strict

      public ResponseInfo strict(Object value)
      Sets strict mode on this bean.
      Overrides:
      strict in class SwaggerElement
      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.