ApiParameter<T> class

Represents a parameter used in an API request.

T - The Dart type of the parameter.

Constructors

ApiParameter(String name, {Object? def, String? description, bool isRequired = false, ParamIn paramIn = ParamIn.query})

Properties

def ↔ Object?
Default value for the parameter.
getter/setter pair
description ↔ String?
Optional description of the parameter.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
isRequired ↔ bool
Indicates whether the parameter is required.
getter/setter pair
name ↔ String
The name of the parameter.
getter/setter pair
paramIn ↔ ParamIn
The location where the parameter is expected in the request.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
type → Type
The Dart type of the parameter.
no setter
typeString → String
The type of the parameter as a string according to OpenAPI specification.
no setter

Methods

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