@loopback/docs
Version:
Documentation files rendered at [https://loopback.io](https://loopback.io)
315 lines (140 loc) • 4.15 kB
Markdown
---
lang: en
title: 'API docs: rest.httphandler'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/rest
permalink: /doc/en/lb4/apidocs.rest.httphandler.html
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@loopback/rest](./rest.md) > [HttpHandler](./rest.httphandler.md)
## HttpHandler class
**Signature:**
```typescript
export declare class HttpHandler
```
## Constructors
<table><thead><tr><th>
Constructor
</th><th>
Modifiers
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[(constructor)(\_rootContext, \_serverConfig, \_routes)](./rest.httphandler._constructor_.md)
</td><td markdown="1">
</td><td markdown="1">
Constructs a new instance of the `HttpHandler` class
</td></tr>
</tbody></table>
## Properties
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[\_openApiComponents](./rest.httphandler._openapicomponents.md)
</td><td markdown="1">
`protected`
</td><td markdown="1">
ComponentsObject
</td><td markdown="1">
Shared OpenAPI spec objects as `components`
</td></tr>
<tr><td markdown="1">
[\_rootContext](./rest.httphandler._rootcontext.md)
</td><td markdown="1">
`protected`
`readonly`
</td><td markdown="1">
[Context](./context.context.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[\_routes](./rest.httphandler._routes.md)
</td><td markdown="1">
`protected`
`readonly`
</td><td markdown="1">
[RoutingTable](./rest.routingtable.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[\_serverConfig](./rest.httphandler._serverconfig.md)
</td><td markdown="1">
`protected`
`readonly`
</td><td markdown="1">
[RestServerResolvedConfig](./rest.restserverresolvedconfig.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[handleRequest](./rest.httphandler.handlerequest.md)
</td><td markdown="1">
</td><td markdown="1">
(request: Request, response: Response) => Promise<void>
</td><td markdown="1">
</td></tr>
</tbody></table>
## Methods
<table><thead><tr><th>
Method
</th><th>
Modifiers
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[\_handleRequest(request, response)](./rest.httphandler._handlerequest.md)
</td><td markdown="1">
`protected`
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[describeApiPaths()](./rest.httphandler.describeapipaths.md)
</td><td markdown="1">
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[findRoute(request)](./rest.httphandler.findroute.md)
</td><td markdown="1">
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[getApiComponents()](./rest.httphandler.getapicomponents.md)
</td><td markdown="1">
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[getApiDefinitions()](./rest.httphandler.getapidefinitions.md)
</td><td markdown="1">
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[registerApiComponents(defs)](./rest.httphandler.registerapicomponents.md)
</td><td markdown="1">
</td><td markdown="1">
Merge components into the OpenApi spec
</td></tr>
<tr><td markdown="1">
[registerApiDefinitions(defs)](./rest.httphandler.registerapidefinitions.md)
</td><td markdown="1">
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[registerController(spec, controllerCtor, controllerFactory)](./rest.httphandler.registercontroller.md)
</td><td markdown="1">
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[registerRoute(route)](./rest.httphandler.registerroute.md)
</td><td markdown="1">
</td><td markdown="1">
</td></tr>
</tbody></table>