Class ApiEndpoint

Namespace: Sisk.Documenting

Assembly: Sisk.Documenting.dll

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

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

Description: Gets the description of the API endpoint.

Group: Gets the group to which the API endpoint belongs.

Headers: Gets the headers associated with the API endpoint.

Name: Gets the name of the API endpoint.

Parameters: Gets the parameters accepted by the API endpoint.

Path: Gets the path of the API endpoint.

PathParameters: Gets the path parameters for the API endpoint.

RequestExamples: Gets the parameters accepted by the API endpoint.

Responses: Gets the possible responses from the API endpoint.

RouteMethod: Gets the route method used for the API endpoint.