DocumentV2<T extends Map<String, dynamic> > class
OpenAPI 2.0 (Swagger) Document
- Inheritance
-
- Object
- OpenAPIDocument<
Map< String, dynamic> > - DocumentV2
Constructors
-
DocumentV2({String? basePath, List<
String> ? consumes, required Map<String, SchemaObjectV2> definitions, ExternalDocumentationObjectV2? externalDocs, String? host, required InfoObject info, String swagger = '2.0', List<String> ? schemes, List<String> ? produces, List<TagObjectV2> ? tags, Map<String, ResponseObjectV2> ? responses, Map<String, ParameterObjectV2> ? parameters, List<Map< ? security, Map<String, List< >String> >String, SecuritySchemeObjectV2> ? securityDefinitions, required Map<String, PathItemObjectV2> paths}) - Creates a DocumentV2 with the given parameters.
- DocumentV2.fromMap(Map map)
-
Creates a DocumentV2 from a map.
factory
Properties
- basePath → String?
-
The base path for the API.
final
-
consumes
→ List<
String> ? -
The MIME types accepted by the API.
final
-
definitions
→ Map<
String, SchemaObjectV2> -
The definitions of the API's data models.
final
-
extensions
→ Map<
String, dynamic> ? -
Vendor-specific extension fields (
x-*) merged into the document.finalinherited - externalDocs → ExternalDocumentationObjectV2?
-
Additional external documentation for the API.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- host → String?
-
The host (name or IP) serving the API.
final
- info → InfoObject
-
The info field contains metadata about the API.
finalinherited
-
parameters
→ Map<
String, ParameterObjectV2> ? -
The available parameters for the API.
final
-
paths
→ Map<
String, PathItemObjectV2> -
The available paths and operations for the API.
final
-
produces
→ List<
String> ? -
The MIME types produced by the API.
final
-
responses
→ Map<
String, ResponseObjectV2> ? -
The available responses for the API.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
schemes
→ List<
String> ? -
The transfer protocols supported by the API.
final
-
security
→ List<
Map< ?String, List< >String> > -
A declaration of which security schemes are applied for the API as a whole.
final
-
securityDefinitions
→ Map<
String, SecuritySchemeObjectV2> ? -
The security definitions (authentication schemes) for the API.
final
- swagger → String
-
The Swagger version (should be "2.0").
final
-
The list of tags used by the API with additional metadata.
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