On this page

module:Endpoint

new module:Endpoint(securitySchemes, securityCallbacks, definition, controllerFunc, enforceResponseValidation)

Endpoint constructor

Parameters:

Name	Type	Description
`securitySchemes`	Array.<Object>	openapi top-level security definition
`securityCallbacks`	Map.<string, function()>	matching security definition validators
`definition`	object	openapi endpoint definition
`controllerFunc`	Map.<string, function()>	matching endpoint controller function
`enforceResponseValidation`	boolean	flag for failing invalid responses (that don't match the endpoint's responseScheme)

Source: lib/Endpoint.js, line 21
See: https://swagger.io/docs/specification/authentication/
https://swagger.io/docs/specification/paths-and-operations/

Methods

(async) testIncoming(path, headers, queryParams, contentType, bodyParams)

Test request against the endpoint input validators

Parameters:

Name	Type	Description
`path`	Map.<string, any>	path parameters object
`headers`	Map.<string, any>	header parameters object
`queryParams`	Map.<string, any>	query string parameters object
`contentType`	string	content type of the input
`bodyParams`	Map.<string, any>	body

Source: lib/Endpoint.js, line 60

Throws:

module:ParameterError | module:SecurityError

(async) testOutgoing(statusCode, contentType, responseBody) → {Promise.<(ResponseError|boolean)>}

Test response against the endpoint output validators

Parameters:

Name	Type	Description
`statusCode`	string	response status code
`contentType`	string	response content type
`responseBody`	object	response body

Source: lib/Endpoint.js, line 74

Returns:

Type:: Promise.<(ResponseError|boolean)>