OpenApiController class

Controller to serve the OpenAPI UI

Constructors

OpenApiController({required String specPath, required String path})

Constructor

Properties

exceptionFilters → Set<ExceptionFilter>

The exceptionFilters property contains the exception filters of the controller.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

hooks → HooksContainer

The hooksContainer property contains the hooks container of the controller.

final, inherited

metadata → List<Metadata>

The metadata property contains the metadata of the controller.

no setter, inherited

path → String

The path property contains the path of the controller.

final, inherited

pipes ↔ List<Pipe>

The list of pipes to be applied.

getter/setter pair, inherited

routes → Map<String, RestRouteHandlerSpec>

The routes property contains the routes of the controller.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

specPath → String

Path to the OpenAPI specification file.

final

version → int?

The version property contains the version of the controller.

no setter, inherited

Methods

get(String routeId) → RestRouteHandlerSpec?

The get method is used to get a route.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

on<T, B>(Route route, Future<T> handler(RequestContext<B> context), {bool shouldValidateMultipart = false}) → void

The on method is used to register a route.

inherited

onStatic<T>(Route route, T handler) → void

The onStatic method is used to register a static route. It takes a Route and a Object value.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited