DocumentV3 class

OpenAPI document representing the root document of the OpenAPI specification.

Inheritance

Constructors

DocumentV3({required InfoObject info, required Map<String, PathItemObjectV3?> paths, List<ServerObjectV3>? servers, String openapi = '3.0.0', ComponentsObjectV3? components, List<SecurityRequirementsV3>? security, List<TagObjectV3>? tags, ExternalDocumentationObjectV3? externalDocs, Map<String, dynamic>? extensions})
Creates a DocumentV3 with the given parameters.
DocumentV3.fromMap(Map map)
Creates a DocumentV3 from a map.
factory

Properties

components → ComponentsObjectV3?
The components object containing reusable components.
final
extensions → Map<String, dynamic>?
Vendor-specific extension fields (x-*) merged into the document.
finalinherited
externalDocs → ExternalDocumentationObjectV3?
External documentation for the API.
final
hashCode → int
The hash code for this object.
no setterinherited
info → InfoObject
finalinherited
openapi → String
The OpenAPI version.
final
paths → Map<String, PathItemObjectV3?>
A map of path strings to path item objects.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
security → List<SecurityRequirementsV3>?
A list of security requirement objects.
final
servers → List<ServerObjectV3>?
A list of server objects.
final
tags → List<TagObjectV3>?
A list of tag objects.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
Converts the OpenAPIDocument to a map.
override
toString() → String
A string representation of this object.
inherited

Operators

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