Sisk

Class

ApiEndpoint

Namespace
Sisk.Documenting
Assembly
Sisk.Documenting.dll

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

C#
public sealed class ApiEndpoint

Inheritance #

object ← ApiEndpoint

Inherited Members #

object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Properties #

NameDescription
DescriptionGets the description of the API endpoint.
GroupGets the group to which the API endpoint belongs.
HeadersGets the headers associated with the API endpoint.
NameGets the name of the API endpoint.
ParametersGets the parameters accepted by the API endpoint.
PathGets the path of the API endpoint.
PathParametersGets the path parameters for the API endpoint.
RequestExamplesGets the parameters accepted by the API endpoint.
ResponsesGets the possible responses from the API endpoint.
RouteMethodGets the route method used for the API endpoint.

Type to search the documentation and the API reference.