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.

Inheritance

Constructors

APIInfo(String title, String version, { String description, Uri termsOfServiceURL, APILicense license, APIContact contact })
Creates empty metadata for specification.
APIInfo.empty()

Properties

contact APIContact
The contact information for the exposed API.
read / write
description ↔ String
A short description of the application. [...]
read / write
license APILicense
The license information for the exposed API.
read / write
termsOfServiceURL ↔ Uri
A URL to the Terms of Service for the API. [...]
read / write
title ↔ String
The title of the application. [...]
read / write
version ↔ String
The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version). [...]
read / write
castMap → Map<String, Cast>
read-only, inherited
extensions ↔ Map<String, dynamic>
read / write, inherited
hashCode → int
The hash code for this object.
read-only, inherited
referenceURI ↔ Uri
read / write, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

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
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) → bool
The equality operator.
inherited