Response class abstract

A container for the expected responses of an operation.

The container maps a HTTP response code to the expected response.

https://swagger.io/specification/#response-object

Annotations

• @freezed

Constructors

Response({@Default.new('') String description, Map<String, Header>? headers, Map<String, MediaType>? content, Map<String, Link>? links, @JsonKey.new(name: '\$ref') @_ResponseRefConverter.new() String? ref})

const

factory

Response.fromJson(Map<String, dynamic> json)

factory

Properties

content → Map<String, MediaType>?

A map containing descriptions of potential response payloads.

no setter, inherited

copyWith → $ResponseCopyWith<Response>

Create a copy of Response with the given fields replaced by the non-null parameter values.

no setter, inherited

description → String

A description of the response

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

headers → Map<String, Header>?

Maps a header name to its definition. RFC7230 states header names are case insensitive.

no setter, inherited

links → Map<String, Link>?

A map containing descriptions of potential response payloads.

no setter, inherited

ref → String?

Reference to a response defined in Components.responses

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

dereference({required Map<String, Response>? components}) → Response

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Serializes this Response to a JSON map.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited