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

Constructors

APIComponents()
APIComponents.empty()

Properties

callbacks ↔ Map<String, APICallback>
An object to hold reusable APICallback.
read / write
headers ↔ Map<String, APIHeader>
An object to hold reusable APIHeader.
read / write
parameters ↔ Map<String, APIParameter>
An object to hold reusable APIParameter.
read / write
requestBodies ↔ Map<String, APIRequestBody>
An object to hold reusable APIRequestBody.
read / write
responses ↔ Map<String, APIResponse>
An object to hold reusable APIResponse.
read / write
schemas ↔ Map<String, APISchemaObject>
An object to hold reusable APISchemaObject.
read / write
securitySchemes ↔ Map<String, APISecurityScheme>
An object to hold reusable APISecurityScheme.
read / write
castMap → Map<String, Cast>
read-only, inherited
extensions ↔ Map<String, dynamic>
read / write, inherited
hashCode → int
The hash code for this object.
read-only, inherited
referenceURI ↔ Uri
read / write, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

decode(KeyedArchive object) → void
override
encode(KeyedArchive object) → void
override
resolve<T extends APIObject>(T refObject) → T
resolveUri(Uri uri) APIObject
Returns a component definition for uri. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
toString() → String
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) → bool
The equality operator.
inherited