# ApiEndpoint

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

Represents an API endpoint, including its metadata, request and response details.

```csharp
public sealed class ApiEndpoint
```

#### Inheritance

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

#### Inherited Members

[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype), 
[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)

## Properties

| Name | Description |
| --- | --- |
| [CanonicalName](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiEndpoint.CanonicalName.md#Sisk_Documenting_ApiEndpoint_CanonicalName) | Gets the canonical name of the API endpoint (the route name). |
| [Description](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiEndpoint.Description.md#Sisk_Documenting_ApiEndpoint_Description) | Gets the description of the API endpoint. |
| [Group](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiEndpoint.Group.md#Sisk_Documenting_ApiEndpoint_Group) | Gets the group to which the API endpoint belongs. |
| [Headers](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiEndpoint.Headers.md#Sisk_Documenting_ApiEndpoint_Headers) | Gets the headers associated with the API endpoint. |
| [Name](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiEndpoint.Name.md#Sisk_Documenting_ApiEndpoint_Name) | Gets the name of the API endpoint. |
| [Order](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiEndpoint.Order.md#Sisk_Documenting_ApiEndpoint_Order) | Gets the relative ordering index for this instance within its containing collection or context. |
| [ParameterExamples](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiEndpoint.ParameterExamples.md#Sisk_Documenting_ApiEndpoint_ParameterExamples) | Gets the situational examples associated with request parameters. |
| [Parameters](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiEndpoint.Parameters.md#Sisk_Documenting_ApiEndpoint_Parameters) | Gets the parameters accepted by the API endpoint. |
| [Path](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiEndpoint.Path.md#Sisk_Documenting_ApiEndpoint_Path) | Gets the path of the API endpoint. |
| [PathParameters](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiEndpoint.PathParameters.md#Sisk_Documenting_ApiEndpoint_PathParameters) | Gets the path parameters for the API endpoint. |
| [QueryParameters](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiEndpoint.QueryParameters.md#Sisk_Documenting_ApiEndpoint_QueryParameters) | Gets the collection of query parameters supported by the API endpoint. |
| [RequestExamples](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiEndpoint.RequestExamples.md#Sisk_Documenting_ApiEndpoint_RequestExamples) | Gets the example requests accepted by the API endpoint. |
| [Responses](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiEndpoint.Responses.md#Sisk_Documenting_ApiEndpoint_Responses) | Gets the possible responses from the API endpoint. |
| [RouteMethod](https://docs.sisk-framework.org/api/Sisk.Documenting.ApiEndpoint.RouteMethod.md#Sisk_Documenting_ApiEndpoint_RouteMethod) | Gets the route method used for the API endpoint. |