APIOperationDocumenter class abstract

The methods you implement to document the operations of a Controller.

The documentation process calls these methods for every Controller in your ApplicationChannel. You implement documentOperations to create or modify APIOperation objects that describe the HTTP operations that a controller handler.

Implementers

• Controller

Constructors

APIOperationDocumenter()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

documentOperations(APIDocumentContext context, String route, APIPath path) → Map<String, APIOperation>

Tells this object to return all APIOperations it handles.

documentPaths(APIDocumentContext context) → Map<String, APIPath>

Tells this object to return all APIPaths it handles.

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