Class
ApiDocumentationHandler
Provides hooks for filtering and customizing generated API documentation.
public abstract class ApiDocumentationHandlerInheritance #
object ← ApiDocumentationHandler
Inherited Members #
object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Remarks #
Item hooks run after documentation from the route and its request handlers is collected and before
ShouldCreateApiEndpoint is called. Returning false excludes the item;
returning true includes it. Override a hook to modify the supplied item before it is exported.
Constructors #
| Name | Description |
|---|---|
| ApiDocumentationHandler() |
Methods #
| Name | Description |
|---|---|
| HandleApiEndpointHeader(ApiEndpointHeader, Route) | Filters or customizes a documented request header for a route. |
| HandleApiEndpointParameter(ApiEndpointParameter, Route) | Filters or customizes a documented request parameter for a route. |
| HandleApiEndpointParameterExample(ApiEndpointParameterExample, Route) | Filters or customizes a documented request parameter example for a route. |
| HandleApiEndpointPathParameter(ApiEndpointPathParameter, Route) | Filters or customizes a documented path parameter for a route. |
| HandleApiEndpointQueryParameter(ApiEndpointQueryParameter, Route) | Filters or customizes a documented query parameter for a route. |
| HandleApiEndpointRequestExample(ApiEndpointRequestExample, Route) | Filters or customizes a documented request example for a route. |
| HandleApiEndpointResponse(ApiEndpointResponse, Route) | Filters or customizes a documented response for a route. |
| ShouldCreateApiEndpoint(ApiEndpoint, Route) | Determines whether the generated documentation endpoint should be included. |