Node.js RESTful API
RESTとは？
RESTとは表現的状態転送（英語：Representational State Transfer、略称REST）であり、Roy Fielding博士が2000年に彼の博士論文で提唱したソフトウェアアーキテクチャスタイルです。
表現的状態転送は、一連のアーキテクチャ上の制約条件と原則です。これらの制約条件と原則を満たすアプリケーションまたは設計がRESTfulです。注意すべき点は、RESTは設計スタイルであり、標準ではないということです。RESTは通常、HTTP、URI、XML（標準汎用マークアップ言語のサブセット）、HTML（標準汎用マークアップ言語のアプリケーション）といった、広く普及している既存のプロトコルと標準に基づいています。RESTは通常JSONデータ形式を使用します。
HTTP メソッド
以下はREST基本アーキテクチャの4つのメソッドです：GET- データの取得に使用されます。
PUT- データの更新または追加に使用されます。
DELETE- データの削除に使用されます。
POST- データの追加に使用されます。
RESTful Web Services
Webサービスは、プラットフォームに依存せず、疎結合で、自己完結型の、プログラマブルなWebベースのアプリケーションです。これらのアプリケーションを記述、公開、発見、調整、構成するためにオープンなXML（標準汎用マークアップ言語のサブセット）標準を使用でき、分散型の相互運用可能なアプリケーションの開発に使用されます。
RESTアーキテクチャに基づくWebサービスがRESTfulです。
軽量であり、HTTPを介して直接データを転送する特性により、WebサービスのRESTful方式は最も一般的な代替手段となっています。クライアントはさまざまな言語（Javaプログラム、Perl、Ruby、Python、PHP、JavaScript[Ajaxを含む]など）で実装できます。
RESTful Webサービスは通常、自動クライアントまたはユーザーに代わるアプリケーションからアクセスできます。しかし、このサービスの簡便さにより、ユーザーはWebブラウザを使用してGET URLを構築し、返されたコンテンツを読み取ることで直接対話できます。
詳細については、以下を参照してください：RESTfulアーキテクチャ詳解
RESTful の作成
まず、JSONデータリソースファイル users.json を作成します。内容は次のとおりです：
{
"user1" : {
"name" : "mahesh",
"password" : "password1",
"profession" : "teacher",
"id": 1
},
"user2" : {
"name" : "suresh",
"password" : "password2",
"profession" : "librarian",
"id": 2
},
"user3" : {
"name" : "ramesh",
"password" : "password3",
"profession" : "clerk",
"id": 3
}
}
上記のデータに基づいて、以下のRESTful APIを作成します：
| 番号 | URI | HTTP メソッド | 送信内容 | 結果 |
|---|---|---|---|---|
| 1 | listUsers | GET | 空 | すべてのユーザーリストを表示 |
| 2 | addUser | POST | JSON文字列 | 新しいユーザーの追加 |
| 3 | deleteUser | DELETE | JSON文字列 | ユーザーの削除 |
| 4 | :id | GET | 空 | ユーザー詳細情報の表示 |
ユーザーリストの取得：
以下のコードで、RESTful APIを作成しましたlistUsers、ユーザー情報のリストを読み取るためのものです。server.js ファイルのコードは次のとおりです：
var express = require('express');
var app = express();
var fs = require("fs");
app.get('/listUsers', function (req, res) {
fs.readFile( __dirname + "/" + "users.json", 'utf8', function (err, data) {
console.log( data );
res.end( data );
});
})
var server = app.listen(8081, function () {
var host = server.address().address
var port = server.address().port
console.log("应用实例，访问地址为 http://%s:%s", host, port)
})
次に、以下のコマンドを実行します：
$ node server.js 应用实例，访问地址为 http://0.0.0.0:8081
ブラウザで http://127.0.0.1:8081/listUsers にアクセスすると、結果は次のようになります：
{
"user1" : {
"name" : "mahesh",
"password" : "password1",
"profession" : "teacher",
"id": 1
},
"user2" : {
"name" : "suresh",
"password" : "password2",
"profession" : "librarian",
"id": 2
},
"user3" : {
"name" : "ramesh",
"password" : "password3",
"profession" : "clerk",
"id": 3
}
}
ユーザーの追加
以下のコードで、RESTful APIを作成しましたaddUser、新しいユーザーデータを追加するためのものです。server.js ファイルのコードは次のとおりです：
var express = require('express');
var app = express();
var fs = require("fs");
//添加的新用户数据
var user = {
"user4" : {
"name" : "mohit",
"password" : "password4",
"profession" : "teacher",
"id": 4
}
}
app.get('/addUser', function (req, res) {
// 读取已存在的数据
fs.readFile( __dirname + "/" + "users.json", 'utf8', function (err, data) {
data = JSON.parse( data );
data["user4"] = user["user4"];
console.log( data );
res.end( JSON.stringify(data));
});
})
var server = app.listen(8081, function () {
var host = server.address().address
var port = server.address().port
console.log("应用实例，访问地址为 http://%s:%s", host, port)
})
次に、以下のコマンドを実行します：
$ node server.js 应用实例，访问地址为 http://0.0.0.0:8081
ブラウザで http://127.0.0.1:8081/addUser にアクセスすると、結果は次のようになります：
{ user1:
{ name: 'mahesh',
password: 'password1',
profession: 'teacher',
id: 1 },
user2:
{ name: 'suresh',
password: 'password2',
profession: 'librarian',
id: 2 },
user3:
{ name: 'ramesh',
password: 'password3',
profession: 'clerk',
id: 3 },
user4:
{ name: 'mohit',
password: 'password4',
profession: 'teacher',
id: 4 }
}
ユーザー詳細の表示
以下のコードで、RESTful APIを作成しました:id（ユーザーID）、指定したユーザーの詳細情報を読み取るためのものです。server.js ファイルのコードは次のとおりです：
var express = require('express');
var app = express();
var fs = require("fs");
app.get('/:id', function (req, res) {
// 首先我们读取已存在的用户
fs.readFile( __dirname + "/" + "users.json", 'utf8', function (err, data) {
data = JSON.parse( data );
var user = data["user" + req.params.id]
console.log( user );
res.end( JSON.stringify(user));
});
})
var server = app.listen(8081, function () {
var host = server.address().address
var port = server.address().port
console.log("应用实例，访问地址为 http://%s:%s", host, port)
})
次に、以下のコマンドを実行します：
$ node server.js 应用实例，访问地址为 http://0.0.0.0:8081
ブラウザで http://127.0.0.1:8081/2 にアクセスすると、結果は次のようになります：
{
"name":"suresh",
"password":"password2",
"profession":"librarian",
"id":2
}
ユーザーの削除
以下のコードで、RESTful APIを作成しましたdeleteUser、指定したユーザーの詳細情報を削除するためのものです。以下の例では、ユーザーIDは2です。server.js ファイルのコードは次のとおりです：
var express = require('express');
var app = express();
var fs = require("fs");
var id = 2;
app.get('/deleteUser', function (req, res) {
// First read existing users.
fs.readFile( __dirname + "/" + "users.json", 'utf8', function (err, data) {
data = JSON.parse( data );
delete data["user" + id];
console.log( data );
res.end( JSON.stringify(data));
});
})
var server = app.listen(8081, function () {
var host = server.address().address
var port = server.address().port
console.log("应用实例，访问地址为 http://%s:%s", host, port)
})
次に、以下のコマンドを実行します：
$ node server.js 应用实例，访问地址为 http://0.0.0.0:8081
ブラウザで http://127.0.0.1:8081/deleteUser にアクセスすると、結果は次のようになります：
{ user1:
{ name: 'mahesh',
password: 'password1',
profession: 'teacher',
id: 1 },
user3:
{ name: 'ramesh',
password: 'password3',
profession: 'clerk',
id: 3 }
}
その他の拡張