APIDocument class
This is the root document object of the OpenAPI document.
Constructors
- APIDocument()
- Creates an empty specification.
-
APIDocument.fromMap(Map<
String, dynamic> map) - Creates a specification from decoded JSON or YAML document object.
Properties
-
castMap
→ Map<
String, Cast> ? -
no setterinherited
- components ↔ APIComponents?
-
An element to hold various schemas for the specification.
getter/setter pair
-
extensions
↔ Map<
String, dynamic> -
getter/setter pairinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- info ↔ APIInfo?
-
Provides metadata about the API.
getter/setter pair
-
paths
↔ Map<
String, APIPath?> ? -
The available paths and operations for the API.
getter/setter pair
- referenceURI ↔ Uri?
-
getter/setter pairinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
security
↔ List<
APISecurityRequirement?> ? -
A declaration of which security mechanisms can be used across the API.
getter/setter pair
-
servers
↔ List<
APIServerDescription?> ? -
An array of APIServerDescription, which provide connectivity information to a target server.
getter/setter pair
-
A list of tags used by the specification with additional metadata.
getter/setter pair
- version ↔ String?
-
This string MUST be the semantic version number of the OpenAPI Specification version that the OpenAPI document uses.
getter/setter pair
Methods
-
asMap(
) → Map< String, dynamic> -
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