RESTfulなAPIをNode.jsの
RESTとは何ですか?
つまり、RESTのRepresentational State転送(英語:のRepresentational State転送、RESTと呼ばれる)ソフトウェアアーキテクチャのスタイルに2000年に彼の博士論文で博士ロイフィールディングによって提示されました。
Representational State Transferが建築制約と原則のセットです。 設計やアプリケーションのこれらの制約と原則を満たすのRESTfulです。 、RESTはスタイルではなく、標準であることに注意してください。 RESTは通常、HTTP、URI、およびXML(下の標準一般化マークアップ言語のサブセット)とHTML(標準一般化マークアップ言語でのアプリケーション)を使用し、これらの既存の広範囲のプロトコルおよび標準に基づいています。 RESTは通常、JSONデータ・フォーマットを使用します。
HTTPメソッド
次の4つの基本的な方法のRESTアーキテクチャ:GET -データを取得するために使用されます。
PUT -データを追加するために使用されます。
DELETE -データを削除します。
POST -データを更新または追加するために使用されます。
RESTful Webサービス
Webサービスはプラットフォームに依存しない、疎結合、自己完結型の、プログラマブルなWebベースのアプリケーションで、あなたは、Open XML、記述、公開、発見するための基準(下の標準一般化マークアップ言語のサブセット)、調整を使用することができますそして、相互運用可能な分散アプリケーションの開発のため、これらのアプリケーションを構成します。
RESTfulなあるRESTベースのWebサービスのアーキテクチャ。
HTTP特性データを経由して、軽量で直接転送に、RESTfulなWebサービスメソッドは、最も一般的な代替手段となっています。 あなたは、クライアントを達成するために(例えば[Ajaxを含む] JavaプログラムやPerl、RubyのやPython、PHPやJavaScriptなど)さまざまな言語を使用することができます。
RESTfulなWebサービスは、通常、自動クライアントを介して、またはユーザのアプリケーションのためにアクセスすることができます。 しかし、この単純さは、サービスユーザーが直接のGET URLを構築し、リターンを読むために自分のWebブラウザを使用して、それらと対話することができます。
複数のレポート、あなたが見ることができる: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 | :同上 | 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" + 2]; 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 } }