APIDocument class Null safety

This is the root document object of the OpenAPI document.

Inheritance

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>
read-only, inherited
components APIComponents?
An element to hold various schemas for the specification.
read / write
extensions Map<String, dynamic>
read / write, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
info APIInfo?
Provides metadata about the API. [...]
read / write
paths Map<String, APIPath>
The available paths and operations for the API. [...]
read / write
referenceURI Uri
read / write, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
security List<APISecurityRequirement>
A declaration of which security mechanisms can be used across the API. [...]
read / write
servers List<APIServerDescription>
An array of APIServerDescription, which provide connectivity information to a target server. [...]
read / write
tags List<APITag>
A list of tags used by the specification with additional metadata. [...]
read / write
version String
This string MUST be the semantic version number of the OpenAPI Specification version that the OpenAPI document uses. [...]
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