APIDocument class Null safety
Represents an OpenAPI 2.0 specification.
Constructors
- APIDocument()
- Creates an empty specification.
-
APIDocument.fromMap(Map<
String, dynamic> map) - Creates a specification from decoded JSON or YAML document object.
Properties
- basePath ↔ String?
-
read / write
-
castMap
→ Map<
String, Cast> -
read-only
-
consumes
↔ List<
String> ? -
read / write
-
definitions
↔ Map<
String, APISchemaObject?> ? -
read / write
-
extensions
↔ Map<
String, dynamic> -
read / writeinherited
- hashCode → int
-
The hash code for this object.
read-onlyinherited
- host ↔ String?
-
read / write
- info ↔ APIInfo?
-
read / write
-
parameters
↔ Map<
String, APIParameter?> ? -
read / write
-
paths
↔ Map<
String, APIPath?> ? -
read / write
-
produces
↔ List<
String> ? -
read / write
- referenceURI ↔ Uri?
-
read / writeinherited
-
responses
↔ Map<
String, APIResponse?> ? -
read / write
- runtimeType → Type
-
A representation of the runtime type of the object.
read-onlyinherited
-
schemes
↔ List<
String> ? -
read / write
-
security
↔ List<
Map< ?String, List< ?>String?> > -
read / write
-
securityDefinitions
↔ Map<
String, APISecurityScheme?> ? -
read / write
-
read / write
- version ↔ String
-
read / write
Methods
-
asMap(
) → Map< String, dynamic> -
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
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited