node-restify README

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

Follow restify on

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 currently works on Node.js v22.x, v24.x and v26.x.

License

The MIT License (MIT)

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 .

10.7K ·GitHub

Node-restify

What is this?

restify is a Node.js framework for building REST APIs using connect-style middleware.

Is it a framework or a library?

It's a framework for building servers, with an optional bundled HTTP client, modeled after connect/express middleware patterns.

How do I add it to a project?

Install it from npm as a dependency, then create a server with 'restify.createServer()' and define routes with methods like '.get()' or '.post()'.

What Node.js version do I need?

Restify currently supports Node.js v22.x, v24.x and v26.x.

How is restify different from Express?

Restify is purpose-built for REST APIs (not general web apps/views), with built-in DTrace support, a dedicated HTTP client, and connect-style middleware focused on API semantics rather than templating or page rendering.

Does it include an HTTP client, or just the server?

Yes, restify ships with both a server framework for building APIs and a bundled HTTP client for consuming them.

Are the error classes part of this repo?

No, the errors module used by restify lives in a separate repository.

What are similar projects?

express, koa, martini, apollo-server, sails, hapi, echo, multer

Which topics is it in?

rest-client, rest, middleware, web-framework, node, http, json, rest-api, backend, framework, npm, api

Creator: restify
Size: 4.5 MB
Stars: 10.7K
Updated: CommitSep 04 Releasev12.0.0Aug 25
Age: 15y
Commits · 90 Days