@667/restify 中文文档教程
restify 是一个框架,利用 connect 风格的构建中间件 REST API。 有关完整详细信息,请参阅 http://restify.com
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 旨在支持 Node.js LTS(活动和维护)版本以及 Node.js 当前稳定版本。
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
麻省理工学院许可证 (MIT)
版权所有 (c) 2018 restify
特此免费向任何获得以下副本的人授予许可 本软件和相关文档文件(“软件”),处理 软件不受限制,包括但不限于以下权利 使用、复制、修改、合并、发布、分发、再许可和/或出售 软件,并允许获得软件的人这样做, 受以下条件约束:
上述版权声明和本许可声明应包含在所有 软件的副本或重要部分。
本软件“按原样”提供,不提供任何形式的明示或保证 暗示的,包括但不限于适销性保证, 适用于特定目的和非侵权。 在任何情况下都不得 作者或版权持有人对任何索赔、损害或其他 责任,无论是在合同、侵权或其他方面的行为中,由以下原因引起, 出于或与软件或使用或其他交易有关 软件。
Bugs
请参阅 https://github.com/restify/node-restify/issues。
Other repositories
- For the errors module, please go here.
Mailing list
见 谷歌论坛 .
restify is a framework, utilizing connect style middleware for building REST APIs. For full details, see http://restify.com
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 .