OpenApiInfo class
Provides general metadata about the API.
This includes versioning, title, description, terms of service, contact information, and licensing details.
Constructors
- OpenApiInfo({required String version, required String title, String? description, String? termsOfService, OpenApiContact? contact, OpenApiLicence? licence})
-
Creates API metadata for OpenAPI documentation.
const
Properties
- contact → OpenApiContact?
-
Contact information for the API maintainers.
final
- description → String?
-
A brief description of the API's purpose or functionality.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- licence → OpenApiLicence?
-
Licensing details for the API usage.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- termsOfService → String?
-
URL pointing to the terms of service document.
final
- title → String
-
The title or name of the API.
final
- version → String
-
The version number of the API.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> - Converts API metadata into a map for OpenAPI serialization.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited