APIComponentDocumenter class

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.

Implementers

Constructors

APIComponentDocumenter()

Properties

hashCode → int
The hash code for this object.
read-only, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

documentComponents(APIDocumentContext context) → void
Tells this object to add its components to context. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
toString() → String
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) → bool
The equality operator.
inherited

Static Methods

documentType(APIDocumentContext context, TypeMirror type) APISchemaObject
Creates an APISchemaObject from a reflected class. [...]
documentVariable(APIDocumentContext context, VariableMirror mirror) APISchemaObject
Creates an APISchemaObject from a reflected variable. [...]