Interface APIEndpoint

Interface representing the configuration for an API endpoint.

Memberof

APIEndpoints

interface APIEndpoint {
    $ref?: string;
    endpointId: string;
    url: string;
    method?: HTTPMethod;
    description?: string;
    headers?: Record<string, string>;
    pathParams?: DataObj<APISchemaValidationType>;
    queryParams?: DataObj<APISchemaValidationType>;
    requestBody?: DataObj<APISchemaValidationType>;
    postMappers?: APIMappers;
}

Properties

$ref? endpointId url method? description? headers? pathParams? queryParams? requestBody? postMappers?

Properties

Optional$ref

$ref?: string

endpointId

endpointId: string

url

url: string

Optionalmethod

method?: HTTPMethod

Optionaldescription

description?: string

Optionalheaders

headers?: Record<string, string>

OptionalpathParams

pathParams?: DataObj<APISchemaValidationType>

OptionalqueryParams

queryParams?: DataObj<APISchemaValidationType>

OptionalrequestBody

requestBody?: DataObj<APISchemaValidationType>

OptionalpostMappers

postMappers?: APIMappers

Settings

Member Visibility

On This Page

Properties