@loopback/rest
    TypeScript icon, indicating that this package has built-in type declarations

    11.0.1 • Public • Published

    @loopback/rest

    The REST API package for loopback-next.

    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 3.0 spec (openapi.json/openapi.yaml) generation using @loopback/openapi-v3
    • a default sequence implementation to manage the request and response lifecycle

    NOTE: Starting from 6.0.0, we have introduced a middleware-based sequence, which is is used as the default one for newly generated LoopBack applications using lb4 command from @loopback/cli.

    Installation

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

    npm i @loopback/rest

    Basic Use

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

    import {RestApplication, RestServer} from '@loopback/rest';
    
    const app = new RestApplication();
    app.handler(({request, response}, sequence) => {
      sequence.send(response, 'hello world');
    });
    
    (async function start() {
      await app.start();
    
      const server = await app.getServer(RestServer);
      const port = await server.get('rest.port');
      console.log(`Server is running at http://127.0.0.1:${port}`);
    })();

    Configuration

    See https://loopback.io/doc/en/lb4/Server.html#configuration.

    Contributions

    Tests

    Run npm test from the root folder.

    Contributors

    See all contributors.

    License

    MIT

    Keywords

    none

    Install

    npm i @loopback/rest

    DownloadsWeekly Downloads

    28,792

    Version

    11.0.1

    License

    MIT

    Unpacked Size

    614 kB

    Total Files

    215

    Last publish

    Collaborators

    • rfeng
    • bajtos
    • rmg
    • hacksparrow
    • jannyhou2016
    • dhmlau
    • emonddr
    • jerry-apic
    • theprez
    • marioestradarosa
    • achrinza