APIDocument class

Represents an OpenAPI 2.0 specification.

Inheritance

• Object
• Coding
• APIObject
• APIDocument

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?

getter/setter pair

castMap → Map<String, Cast>

no setter, override

consumes ↔ List<String>

getter/setter pair

definitions ↔ Map<String, APISchemaObject>

getter/setter pair

extensions ↔ Map<String, dynamic>

getter/setter pair, inherited

hashCode → int

The hash code for this object.

no setter, inherited

host ↔ String?

getter/setter pair

info ↔ APIInfo

getter/setter pair

parameters ↔ Map<String, APIParameter>

getter/setter pair

paths ↔ Map<String, APIPath>

getter/setter pair

produces ↔ List<String>

getter/setter pair

referenceURI ↔ Uri

getter/setter pair, inherited

responses ↔ Map<String, APIResponse>

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

schemes ↔ List<String>

getter/setter pair

security ↔ List<Map<String, List<String>>>

getter/setter pair

securityDefinitions ↔ Map<String, APISecurityScheme>

getter/setter pair

tags ↔ List<APITag>

getter/setter pair

version ↔ String

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