APIComponents class

Holds a set of reusable objects for different aspects of the OAS.

All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.

Inheritance

• Object
• Coding
• APIObject
• APIComponents

Constructors

APIComponents()

APIComponents.empty()

Properties

callbacks ↔ Map<String, APICallback>

An object to hold reusable APICallback.

getter/setter pair

castMap → Map<String, Cast>

no setter, inherited

extensions ↔ Map<String, dynamic>

getter/setter pair, inherited

hashCode → int

The hash code for this object.

no setter, inherited

headers ↔ Map<String, APIHeader>

An object to hold reusable APIHeader.

getter/setter pair

parameters ↔ Map<String, APIParameter>

An object to hold reusable APIParameter.

getter/setter pair

referenceURI ↔ Uri

getter/setter pair, inherited

requestBodies ↔ Map<String, APIRequestBody>

An object to hold reusable APIRequestBody.

getter/setter pair

responses ↔ Map<String, APIResponse>

An object to hold reusable APIResponse.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

schemas ↔ Map<String, APISchemaObject>

An object to hold reusable APISchemaObject.

getter/setter pair

securitySchemes ↔ Map<String, APISecurityScheme>

An object to hold reusable APISecurityScheme.

getter/setter pair

Methods

decode(KeyedArchive object) → void

override

encode(KeyedArchive object) → void

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

resolve<T extends APIObject>(T refObject) → T

resolveUri(Uri uri) → APIObject

Returns a component definition for uri.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited