Model class

Represents the data structure of a method's request or response payload.

A request model defines the data structure of the client-supplied request payload. A response model defines the data structure of the response payload returned by the back end. Although not required, models are useful for mapping payloads between the front end and back end.

A model is used for generating an API's SDK, validating the input request body, and creating a skeletal mapping template.

Method, MethodResponse, Models and Mappings

Constructors

Model({String? contentType, String? description, String? id, String? name, String? schema})

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

factory

Properties

contentType → String?

The content-type for the model.

final

description → String?

The description of the model.

final

hashCode → int

The hash code for this object.

no setter, inherited

id → String?

The identifier for the model resource.

final

name → String?

The name of the model. Must be an alphanumeric string.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

schema → String?

The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "*/" characters in the description of any properties because such "*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited