API docs: rest.middlewaresequence.handle

Home > @loopback/rest > MiddlewareSequence > handle

MiddlewareSequence.handle() method

Runs the default sequence. Given a handler context (request and response), running the sequence will produce a response or an error.

Default sequence executes these groups of middleware:

• cors: Enforces CORS - openApiSpec: Serves OpenAPI specs - findRoute: Finds the appropriate controller method, swagger spec and args for invocation - parseParams: Parses HTTP request to get API argument list - invokeMethod: Invokes the API which is defined in the Application controller method

In front of the groups above, we have a special middleware called sendResponse, which first invokes downstream middleware to get a result and handles the result or error respectively.

• Writes the result from API into the HTTP response (if the HTTP response has not been produced yet by the middleware chain. - Catches error logs it using ‘logError’ if any of the above steps in the sequence fails with an error.

Signature:

handle(context: RequestContext): Promise<void>;

Parameters

Returns:

Promise<void>