@hexlabs/http-api-ts v2.0.37

http-api-ts

A simple way to create routes and routers for HTTP request in Typescript.

Get Started

Create an HTTP Handler with a simple route matching GET /hello returning HTTP 200 world and HTTP 404 for anything else

const handler = router([
  route('/hello', HttpMethod.GET, async () => ({statusCode: 200, body: 'world'}))
]);
// Call locally
console.log(await handler({resource: '/hello', httpMethod: 'GET'}))

Try this on runkit https://runkit.com/embed/gru6l8nuoeyu

Handlers

export type Request = { resource: string, httpMethod: string, headers?: any };

export type Handler<Req extends Request = Request, Res = any> = (request: Req) => Promise<Res>;

A function that takes a Request event and returns a Response For example an AWS API Gateway handler in lambda:

import {APIGatewayProxyEvent, APIGatewayProxyResult} from "aws-lambda";
const helloWorldHandler: Handler<APIGatewayProxyEvent, APIGatewayProxyResult> = async event => ({
  statusCode: 200,
  body: '{"msg": "hello world"}'
})

Handlers are passed to routers shown below.

Routers

Routers provide a way to route requests to a particular handler based on resources like /a/b/1 and http methods like GET, PUT, POST

function router<Req extends Request, Res>(routes: RoutingHttpHandler<Req, Res>[], notFoundResponse: Res = { statusCode: 404, body: '' }): Handler<Req, Res>

RoutingHttpHandlers can be created using one of the following methods and can be nested:

function route(resource: string, method: HttpMethod | undefined, handler: Handler, filter?: Filter): RoutingHttpHandler {

function bind(resourceInfo: resourceInfo, handler: Handler, ...filters: Filter[]): RoutingHttpHandler {

HTTP Methods and paths are used by the router to find the appropriate handler to use

 const router: Handler = router([
    bind(["/", HttpMethod.GET], fetchAllHandler),
    bind(["/{id}", HttpMethod.GET], fetchOneHandler),
    bind(["/{id}", HttpMethod.PATCH], updateHandler),
    bind(["/{id}", HttpMethod.DELETE], deleteHander)
  ], 
  notFoundResponse // optional
  ) 

Routers can be nested to form more complex routers

 const idRoute: Handler = router([
      bind(HttpMethod.GET, fetchOneHandler),
      bind(HttpMethod.PATCH, updateHandler),
      bind(HttpMethod.DELETE, deleteHandler)
    ]);

 const routes: Handler = router([
      bind(HttpMethod.GET, fetchAllHandler),
      bind("/{id}",idRoute )], 
    notFoundResponse // optional
    ); 

Filters

Filters can be attached to any Handler to intercept the Request or Response from the handler. The filter Type signature is defined as

export type Filter = (handler: Handler) => Handler;

A filter to measure time taken by a Handler could be written as

const timingFilter: Filter =
  nextHandler => async event => {
    const before = new Date().getTime();
    const result = await nextHandler(event);
    const after = new Date().getTime();
    console.log(`handler time ${after - before}`);
    return result;
  };

Filters can also combined and attached to a handler using

export function withFilters<T extends Handler>(handler: T, ...filters: Filter[]): T

For example

const helloWorldHandler: Handler = ...
const timingFilter: Filter = ...
const authFilter: Filter = ...
const handlerWithFilters: Handler = 
  withFilters(helloWorldHandler, authFilter, timingFilter) 

Included Filters

Apigateway-ts includes some useful filters as part of the library

• corsFilter : Filter for CORS headers
• loggingFilter: Logs basic Request and Response info
• httpErrorFilter: Catches errors thrown by the handler returning 500 with the thrown error message
• contentType : Sets the content type to whatever you want it to be
• versionFilter: Takes a version argument and logs warnings if header (default X-API-VERSION) does not match
• all: Combines all the above filters into one