APIInfo class
The object provides metadata about the API.
The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.
Constructors
- APIInfo(String? title, String? version, {String? description, Uri? termsOfServiceURL, APILicense? license, APIContact? contact})
- Creates empty metadata for specification.
- APIInfo.empty()
Properties
-
castMap
→ Map<
String, Cast> ? -
no setterinherited
- contact ↔ APIContact?
-
The contact information for the exposed API.
getter/setter pair
- description ↔ String?
-
A short description of the application.
getter/setter pair
-
extensions
↔ Map<
String, dynamic> -
getter/setter pairinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- license ↔ APILicense?
-
The license information for the exposed API.
getter/setter pair
- referenceURI ↔ Uri?
-
getter/setter pairinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- termsOfServiceURL ↔ Uri?
-
A URL to the Terms of Service for the API.
getter/setter pair
- title ↔ String?
-
The title of the application.
getter/setter pair
- version ↔ String?
-
The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).
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
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited