restify
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/restify package

    8.6.0 • Public • Published

    alt text

    restify

    Build Status Dependency Status devDependency Status code style: prettier

    restify is a framework, utilizing connect style middleware for building REST APIs. For full details, see http://restify.com

    Follow restify on alt text

    Usage

    Server

    var restify = require('restify');
    
    const server = restify.createServer({
      name: 'myapp',
      version: '1.0.0'
    });
    
    server.use(restify.plugins.acceptParser(server.acceptable));
    server.use(restify.plugins.queryParser());
    server.use(restify.plugins.bodyParser());
    
    server.get('/echo/:name', function (req, res, next) {
      res.send(req.params);
      return next();
    });
    
    server.listen(8080, function () {
      console.log('%s listening at %s', server.name, server.url);
    });

    Client

    var assert = require('assert');
    var clients = require('restify-clients');
    
    var client = clients.createJsonClient({
      url: 'http://localhost:8080',
      version: '~1.0'
    });
    
    client.get('/echo/mark', function (err, req, res, obj) {
      assert.ifError(err);
      console.log('Server returned: %j', obj);
    });

    Installation

    $ npm install restify

    Supported Node Versions

    Restify aims to support the Node.js LTS (Active and Maintenance) versions along with Node.js current stable version.

    Node Release Supported in Current Version Notes
    11.x Yes Current stable
    10.x Yes Active LTS
    8.x Yes Maintenance LTS
    6.x No Use restify v7.x, team will backport critical issues only
    4.x No Use restify v7.x, team will backport critical issues only

    License

    The MIT License (MIT)

    Copyright (c) 2018 restify

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Bugs

    See https://github.com/restify/node-restify/issues.

    Other repositories

    • For the errors module, please go here.

    Mailing list

    See the Google group .

    Install

    npm i restify

    Homepage

    restify.com

    DownloadsWeekly Downloads

    136,018

    Version

    8.6.0

    License

    MIT

    Unpacked Size

    333 kB

    Total Files

    63

    Last publish

    Collaborators

    • retrohack3r
    • trentm
    • ghermeto
    • micahr
    • mmarchini
    • pfmooney
    • hekike
    • mcavage
    • yunong
    • jgilli
    • donutespresso
    • rajatkumar
    • daviande