OpenApiRouteReader class
Turns one live route into a RouteDoc.
It joins what the route knows at runtime (method, path, middleware)
with what dox_builder found in the code (OpenApiRegistry).
Constructors
- OpenApiRouteReader(OpenApiConfig config)
Properties
- config → OpenApiConfig
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- usesBearerAuth ↔ bool
-
true when a route got bearerAuth by default
getter/setter pair
- usesValidationError ↔ bool
-
true when a route needs the validationError schema
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
read(
RouteData route) → RouteDoc? -
docs for
route, or null when it has@ApiIgnore() -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
- bearerAuth → const String
- name of the default login scheme
- validationError → const String
- name of the schema for the 422 answer