# ApiDocumentationHandler

Kind: Class  
Namespace: `Sisk.Documenting`  
Assembly: `Sisk.Documenting.dll`  
Source: https://docs.sisk-framework.org/api/Sisk.Documenting.ApiDocumentationHandler.html

Provides hooks for filtering and customizing generated API documentation.

```csharp
public abstract class ApiDocumentationHandler
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ← 
[ApiDocumentationHandler](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiDocumentationHandler.md)

#### Inherited Members

[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype), 
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone), 
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring), 
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)), 
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)), 
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals), 
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode)

## Remarks

Item hooks run after documentation from the route and its request handlers is collected and before
[ShouldCreateApiEndpoint](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiDocumentationHandler.ShouldCreateApiEndpoint.md) is called. Returning [`false`](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool) excludes the item;
returning [`true`](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool) includes it. Override a hook to modify the supplied item before it is exported.

## Constructors

| Name | Description |
| --- | --- |
| [ApiDocumentationHandler\(\)](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiDocumentationHandler.-ctor.md#Sisk_Documenting_ApiDocumentationHandler__ctor) |  |

## Methods

| Name | Description |
| --- | --- |
| [HandleApiEndpointHeader\(ApiEndpointHeader, Route\)](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiDocumentationHandler.HandleApiEndpointHeader.md#Sisk_Documenting_ApiDocumentationHandler_HandleApiEndpointHeader_Sisk_Documenting_ApiEndpointHeader_Sisk_Core_Routing_Route_) | Filters or customizes a documented request header for a route. |
| [HandleApiEndpointParameter\(ApiEndpointParameter, Route\)](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiDocumentationHandler.HandleApiEndpointParameter.md#Sisk_Documenting_ApiDocumentationHandler_HandleApiEndpointParameter_Sisk_Documenting_ApiEndpointParameter_Sisk_Core_Routing_Route_) | Filters or customizes a documented request parameter for a route. |
| [HandleApiEndpointParameterExample\(ApiEndpointParameterExample, Route\)](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiDocumentationHandler.HandleApiEndpointParameterExample.md#Sisk_Documenting_ApiDocumentationHandler_HandleApiEndpointParameterExample_Sisk_Documenting_ApiEndpointParameterExample_Sisk_Core_Routing_Route_) | Filters or customizes a documented request parameter example for a route. |
| [HandleApiEndpointPathParameter\(ApiEndpointPathParameter, Route\)](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiDocumentationHandler.HandleApiEndpointPathParameter.md#Sisk_Documenting_ApiDocumentationHandler_HandleApiEndpointPathParameter_Sisk_Documenting_ApiEndpointPathParameter_Sisk_Core_Routing_Route_) | Filters or customizes a documented path parameter for a route. |
| [HandleApiEndpointQueryParameter\(ApiEndpointQueryParameter, Route\)](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiDocumentationHandler.HandleApiEndpointQueryParameter.md#Sisk_Documenting_ApiDocumentationHandler_HandleApiEndpointQueryParameter_Sisk_Documenting_ApiEndpointQueryParameter_Sisk_Core_Routing_Route_) | Filters or customizes a documented query parameter for a route. |
| [HandleApiEndpointRequestExample\(ApiEndpointRequestExample, Route\)](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiDocumentationHandler.HandleApiEndpointRequestExample.md#Sisk_Documenting_ApiDocumentationHandler_HandleApiEndpointRequestExample_Sisk_Documenting_ApiEndpointRequestExample_Sisk_Core_Routing_Route_) | Filters or customizes a documented request example for a route. |
| [HandleApiEndpointResponse\(ApiEndpointResponse, Route\)](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiDocumentationHandler.HandleApiEndpointResponse.md#Sisk_Documenting_ApiDocumentationHandler_HandleApiEndpointResponse_Sisk_Documenting_ApiEndpointResponse_Sisk_Core_Routing_Route_) | Filters or customizes a documented response for a route. |
| [ShouldCreateApiEndpoint\(ApiEndpoint, Route\)](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiDocumentationHandler.ShouldCreateApiEndpoint.md#Sisk_Documenting_ApiDocumentationHandler_ShouldCreateApiEndpoint_Sisk_Documenting_ApiEndpoint_Sisk_Core_Routing_Route_) | Determines whether the generated documentation endpoint should be included. |