OpenApiJSON class
Represents the root structure of an OpenAPI (3.x) specification document.
This class aggregates high-level metadata (info), the available API
paths, reusable components, optional servers, and optional top-level
tags as described by the OpenAPI specification.
Constructors
-
OpenApiJSON({required String openapi, required Info info, required List<
RouteInfo> paths, required List<String> ? tags, required List<Server> ? servers, required Components components}) - Creates an OpenApiJSON instance with all parsed sections.
-
OpenApiJSON.fromJson(Map<
String, dynamic> json) -
Constructs an OpenApiJSON from a decoded OpenAPI JSON map.
factory
Properties
- components → Components
-
Reusable components such as schemas, parameters, responses, etc.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- info → Info
-
General information about the API (title, description, version, contact, etc.).
final
- openapi → String
-
The OpenAPI semantic version string, e.g., "3.0.1".
final
-
paths
→ List<
RouteInfo> -
Flattened list of API routes parsed from the
pathssection.final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
servers
→ List<
Server> ? -
Optional list of server definitions that specify base URLs for the API.
final
-
Optional list of tag names used to group API endpoints.
final
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