node package manager
It’s your turn. Help us improve JavaScript. Take the 2017 JavaScript Ecosystem Survey »



The REST API package for loopback-next.

STATUS: Developer Preview #1

This package is not yet ready for production use. Additionally, this document is also a work-in-progress and some sections may not have corresponding code!


This component provides a REST server for your application instances, complete with:

  • new custom routing engine (special thanks to @bajtos)!
  • tools for defining your application routes
  • OpenAPI 2.0 spec (swagger.json/swagger.yaml) generation
  • a default sequence implementation to manage the request and response lifecycle


To use this package, you'll need to install both @loopback/core and @loopback/rest.

$ npm install --save @loopback/core @loopback/rest

Basic Use

Here's a basic "Hello World" application using @loopback/core and @loopback/rest:

import {Application} from '@loopback/core';
import {RestComponent, RestServer} from '@loopback/rest';
const app = new Application({
  components: [
(async function start() {
  const rest = await app.getServer(RestServer);
  rest.handler((sequence, request, response) => {
    sequence.send(response, 'hello world');
  await app.start();
  console.log(`REST server running on port: ${rest.getSync('rest.port')}`);


The rest package is configured by passing a rest property inside of your Application options.

  const app = new Application({
    components: [
    rest: {
      port: 3001

rest options

Property Type Purpose
port number Specify the port on which the RestServer will listen for traffic.
secure (NOT YET IMPLEMENTED) HttpsConfiguration Provide a collection of secure key materials to the RestServer, which switches it to HTTPS mode.
sequence SequenceHandler Use a custom SequenceHandler to change the behaviour of the RestServer for the request-response lifecycle.





Run npm test from the root folder.


See all contributors.