APIComponentDocumenter class abstract
The methods you implement to document OpenAPI components.
The documentation process calls methods from objects of this type. You implement methods from this interface to add reusable components to your OpenAPI document. You may use these components when documenting other components or when implementing APIOperationDocumenter.
You must implement documentComponents.
ApplicationChannel, Controller, ManagedEntity, and AuthServer all implement this interface.
Constructors
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
documentComponents(
APIDocumentContext context) → void -
Tells this object to add its components to
context
. -
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