APIComponents class Null safety

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
castMap Map<String, Cast>?
read-onlyinherited
extensions Map<String, dynamic>
read / writeinherited
hashCode int
The hash code for this object.
read-onlyinherited
headers Map<String, APIHeader>
An object to hold reusable APIHeader.
read / write
parameters Map<String, APIParameter>
An object to hold reusable APIParameter?.
read / write
referenceURI Uri?
read / writeinherited
requestBodies Map<String, APIRequestBody>
An object to hold reusable APIRequestBody?.
read / write
responses Map<String, APIResponse>
An object to hold reusable APIResponse?.
read / write
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
schemas Map<String, APISchemaObject>
An object to hold reusable APISchemaObject?.
read / write
securitySchemes Map<String, APISecurityScheme>
An object to hold reusable APISecurityScheme?.
read / write

Methods

decode(KeyedArchive object) → void
override
encode(KeyedArchive object) → void
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent 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