node-restify README

The project's README from github.com/restify/node-restify. As one markdown file: README.md.

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

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

Mailing list

See the Google group .

node-restify (restify/node-restify)

Searching Database…

10.7K ·GitHub
Node-restify
Что это?restify — это фреймворк для Node.js, с помощью которого создают REST API с использованием middleware в стиле connect.
Это фреймворк или библиотека?Это фреймворк для создания серверов, с необязательным встроенным HTTP-клиентом, построенный по образцу паттернов middleware из connect/express.
Как добавить его в проект?Установите его из npm как зависимость, затем создайте сервер с помощью 'restify.createServer()' и задайте маршруты методами вроде '.get()' или '.post()'.
Какая версия Node.js мне нужна?Restify сейчас поддерживает Node.js v22.x, v24.x и v26.x.
Чем restify отличается от Express?Restify создан специально для REST API (а не для обычных веб-приложений и представлений). В нём есть встроенная поддержка DTrace, отдельный HTTP-клиент, а также middleware в стиле connect, которое ориентировано на семантику API, а не на шаблонизацию или отрисовку страниц.
Оно включает HTTP-клиент или только сервер?Да, restify поставляется и с фреймворком для создания API, и со встроенным HTTP-клиентом для работы с ними.
Классы ошибок входят в этот репозиторий?Нет, модуль errors, который использует restify, находится в отдельном репозитории.
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 04Releasev12.0.0Aug 25
Age
15y
Commits · 90 Days