@loopback/rest

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!

Overview

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

Installation

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 {RestApplication, RestServer} from '@loopback/rest';

const app = new RestApplication();
app.handler((sequence, request, response) => {
  sequence.send(response, 'hello world');
});

(async function start() {
  await app.start();

  const rest = await app.getServer(RestServer);
  console.log(`REST server running on port: ${rest.getSync('rest.port')}`);
})();

Configuration

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

  const app = new Application({
    rest: {
      port: 3001
    }
  });
  app.component(RestComponent);

rest options

HttpsConfiguration

SequenceHandler

Contributions

• Guidelines
• Join the team

Tests

Run npm test from the root folder.

Contributors

See all contributors.

License

MIT