ExpressJS-RESTFul API

APIは、モバイルアプリケーション、シングルページアプリケーションを作成し、AJAX呼び出しを使用して、クライアントにデータを提供するために常に必要です。これらのAPIとエンドポイントを構造化して名前を付ける方法の一般的なアーキテクチャスタイルは、REST(Representational Transfer State)。 HTTP 1.1RESTの原則を念頭に置いて設計されました。RESTはによって導入されましたRoy Fielding 2000年に彼のペーパーフィールディング論文で。

RESTful URIとメソッドは、リクエストを処理するために必要なほぼすべての情報を提供します。以下の表は、さまざまな動詞の使用方法とURIの命名方法をまとめたものです。最後に、moviesAPIを作成します。それがどのように構成されるかについて議論しましょう。

方法 URI 詳細 関数
取得する /映画 安全で、追跡可能 すべての映画とその詳細のリストを取得します
取得する / movies / 1234 安全で、追跡可能 映画ID1234の詳細を取得します
役職 /映画 該当なし 提供された詳細を使用して新しいムービーを作成します。応答には、この新しく作成されたリソースのURIが含まれています。
プット / movies / 1234 べき等 ムービーID1234を変更します（まだ存在しない場合は作成します）。応答には、この新しく作成されたリソースのURIが含まれています。
削除 / movies / 1234 べき等 ムービーID1234が存在する場合は、削除する必要があります。応答には、要求のステータスが含まれている必要があります。
削除または配置 /映画 無効 無効にする必要があります。 DELETE そして PUT 作業しているリソースを指定する必要があります。

ExpressでこのAPIを作成しましょう。JavaScriptでの操作が簡単で、他にも利点があるため、トランスポートデータ形式としてJSONを使用します。あなたのindex.js とファイル movies.js 次のプログラムのようにファイルします。

index.js

var express = require('express');
var bodyParser = require('body-parser');
var multer = require('multer');
var upload = multer();

var app = express();

app.use(cookieParser());
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: true }));
app.use(upload.array());

//Require the Router we defined in movies.js
var movies = require('./movies.js');

//Use the Router on the sub route /movies
app.use('/movies', movies);

app.listen(3000);

アプリケーションのセットアップが完了したので、APIの作成に集中しましょう。

まず、movies.jsファイルを設定します。映画の保存にデータベースを使用していませんが、メモリに保存しています。そのため、サーバーが再起動するたびに、追加されたムービーは消えます。これは、データベースまたはファイルを使用して（ノードfsモジュールを使用して）簡単に模倣できます。

Expressをインポートしたら、ルーターを作成し、module.exports −を使用してエクスポートします。

var express = require('express');
var router = express.Router();
var movies = [
   {id: 101, name: "Fight Club", year: 1999, rating: 8.1},
   {id: 102, name: "Inception", year: 2010, rating: 8.7},
   {id: 103, name: "The Dark Knight", year: 2008, rating: 9},
   {id: 104, name: "12 Angry Men", year: 1957, rating: 8.9}
];

//Routes will go here
module.exports = router;

ルートを取得

すべての映画を取得するためのGETルートを定義しましょう-

router.get('/', function(req, res){
   res.json(movies);
});

これが正常に機能しているかどうかをテストするには、アプリを実行し、ターミナルを開いて「-」と入力します。

curl -i -H "Accept: application/json" -H "Content-Type: application/json" -X GET 
localhost:3000/movies

次の応答が表示されます-

[{"id":101,"name":"Fight Club","year":1999,"rating":8.1},
{"id":102,"name":"Inception","year":2010,"rating":8.7},
{"id":103,"name":"The Dark Knight","year":2008,"rating":9},
{"id":104,"name":"12 Angry Men","year":1957,"rating":8.9}]

すべての映画を入手するルートがあります。IDで特定の映画を取得するルートを作成しましょう。

router.get('/:id([0-9]{3,})', function(req, res){
   var currMovie = movies.filter(function(movie){
      if(movie.id == req.params.id){
         return true;
      }
   });
   if(currMovie.length == 1){
      res.json(currMovie[0])
   } else {
      res.status(404);//Set status to 404 as movie was not found
      res.json({message: "Not Found"});
   }
});

これにより、指定したIDに従って映画が取得されます。出力を確認するには、端末で次のコマンドを使用します-

curl -i -H "Accept: application/json" -H "Content-Type: application/json" -X GET 
localhost:3000/movies/101

次の応答が返されます-

{"id":101,"name":"Fight Club","year":1999,"rating":8.1}

無効なルートにアクセスすると、 cannot GET error 一方、IDが存在しない有効なルートにアクセスすると、404エラーが発生します。

GETルートが完了しました。次に、 POST ルート。

POSTルート

次のルートを使用して、 POSTed データ-

router.post('/', function(req, res){
   //Check if all fields are provided and are valid:
   if(!req.body.name ||
      !req.body.year.toString().match(/^[0-9]{4}$/g) ||
      !req.body.rating.toString().match(/^[0-9]\.[0-9]$/g)){
      
      res.status(400);
      res.json({message: "Bad Request"});
   } else {
      var newId = movies[movies.length-1].id+1;
      movies.push({
         id: newId,
         name: req.body.name,
         year: req.body.year,
         rating: req.body.rating
      });
      res.json({message: "New movie created.", location: "/movies/" + newId});
   }
});

これにより、新しいムービーが作成され、movies変数に保存されます。このルートを確認するには、ターミナルに次のコードを入力します-

curl -X POST --data "name = Toy%20story&year = 1995&rating = 8.5" http://localhost:3000/movies

次の応答が表示されます-

{"message":"New movie created.","location":"/movies/105"}

これがmoviesオブジェクトに追加されたかどうかをテストするには、次のgetリクエストを実行します。 /movies/105再び。次の応答が表示されます-

{"id":105,"name":"Toy story","year":"1995","rating":"8.5"}

PUTルートとDELETEルートの作成に移りましょう。

PUTルート

PUTルートはPOSTルートとほぼ同じです。更新/作成されるオブジェクトのIDを指定します。次の方法でルートを作成します。

router.put('/:id', function(req, res){
   //Check if all fields are provided and are valid:
   if(!req.body.name ||
      !req.body.year.toString().match(/^[0-9]{4}$/g) ||
      !req.body.rating.toString().match(/^[0-9]\.[0-9]$/g) ||
      !req.params.id.toString().match(/^[0-9]{3,}$/g)){
      
      res.status(400);
      res.json({message: "Bad Request"});
   } else {
      //Gets us the index of movie with given id.
      var updateIndex = movies.map(function(movie){
         return movie.id;
      }).indexOf(parseInt(req.params.id));
      
      if(updateIndex === -1){
         //Movie not found, create new
         movies.push({
            id: req.params.id,
            name: req.body.name,
            year: req.body.year,
            rating: req.body.rating
         });
         res.json({message: "New movie created.", location: "/movies/" + req.params.id});
      } else {
         //Update existing movie
         movies[updateIndex] = {
            id: req.params.id,
            name: req.body.name,
            year: req.body.year,
            rating: req.body.rating
         };
         res.json({message: "Movie id " + req.params.id + " updated.", 
            location: "/movies/" + req.params.id});
      }
   }
});

このルートは、上記の表で指定された機能を実行します。オブジェクトが存在する場合は、新しい詳細でオブジェクトを更新します。存在しない場合は、新しいオブジェクトが作成されます。ルートを確認するには、次のcurlコマンドを使用します。これにより、既存のムービーが更新されます。新しいムービーを作成するには、IDを存在しないIDに変更するだけです。

curl -X PUT --data "name = Toy%20story&year = 1995&rating = 8.5" 
http://localhost:3000/movies/101

Response

{"message":"Movie id 101 updated.","location":"/movies/101"}

ルートを削除

次のコードを使用して、削除ルートを作成します。−

router.delete('/:id', function(req, res){
   var removeIndex = movies.map(function(movie){
      return movie.id;
   }).indexOf(req.params.id); //Gets us the index of movie with given id.
   
   if(removeIndex === -1){
      res.json({message: "Not found"});
   } else {
      movies.splice(removeIndex, 1);
      res.send({message: "Movie id " + req.params.id + " removed."});
   }
});

他のルートと同じ方法でルートを確認してください。削除が成功すると（たとえばID 105）、次の出力が得られます-

{message: "Movie id 105 removed."}

最後に、 movies.js ファイルは次のようになります。

var express = require('express');
var router = express.Router();
var movies = [
   {id: 101, name: "Fight Club", year: 1999, rating: 8.1},
   {id: 102, name: "Inception", year: 2010, rating: 8.7},
   {id: 103, name: "The Dark Knight", year: 2008, rating: 9},
   {id: 104, name: "12 Angry Men", year: 1957, rating: 8.9}
];
router.get('/:id([0-9]{3,})', function(req, res){
   var currMovie = movies.filter(function(movie){
      if(movie.id == req.params.id){
         return true;
      }
   });
   
   if(currMovie.length == 1){
      res.json(currMovie[0])
   } else {
      res.status(404);  //Set status to 404 as movie was not found
      res.json({message: "Not Found"});
   }
});
router.post('/', function(req, res){
   //Check if all fields are provided and are valid:
   if(!req.body.name ||
      !req.body.year.toString().match(/^[0-9]{4}$/g) ||
      !req.body.rating.toString().match(/^[0-9]\.[0-9]$/g)){
      res.status(400);
      res.json({message: "Bad Request"});
   } else {
      var newId = movies[movies.length-1].id+1;
      movies.push({
         id: newId,
         name: req.body.name,
         year: req.body.year,
         rating: req.body.rating
      });
      res.json({message: "New movie created.", location: "/movies/" + newId});
   }
});

router.put('/:id', function(req, res) {
   //Check if all fields are provided and are valid:
   if(!req.body.name ||
      !req.body.year.toString().match(/^[0-9]{4}$/g) ||
      !req.body.rating.toString().match(/^[0-9]\.[0-9]$/g) ||
      !req.params.id.toString().match(/^[0-9]{3,}$/g)){
      res.status(400);
      res.json({message: "Bad Request"});
   } else {
      //Gets us the index of movie with given id.
      var updateIndex = movies.map(function(movie){
         return movie.id;
      }).indexOf(parseInt(req.params.id));
      
      if(updateIndex === -1){
         //Movie not found, create new
         movies.push({
            id: req.params.id,
            name: req.body.name,
            year: req.body.year,
            rating: req.body.rating
         });
         res.json({
            message: "New movie created.", location: "/movies/" + req.params.id});
      } else {
         //Update existing movie
         movies[updateIndex] = {
            id: req.params.id,
            name: req.body.name,
            year: req.body.year,
            rating: req.body.rating
         };
         res.json({message: "Movie id " + req.params.id + " updated.",
            location: "/movies/" + req.params.id});
      }
   }
});

router.delete('/:id', function(req, res){
   var removeIndex = movies.map(function(movie){
      return movie.id;
   }).indexOf(req.params.id); //Gets us the index of movie with given id.
   
   if(removeIndex === -1){
      res.json({message: "Not found"});
   } else {
      movies.splice(removeIndex, 1);
      res.send({message: "Movie id " + req.params.id + " removed."});
   }
});
module.exports = router;

これでRESTAPIが完成しました。これで、この単純なアーキテクチャスタイルとExpressを使用して、はるかに複雑なアプリケーションを作成できます。

ja/tutorial
es/tutorial
de/tutorial
fr/tutorial
th/tutorial
pt/tutorial
ru/tutorial
vi/tutorial
it/tutorial
ko/tutorial
tr/tutorial
id/tutorial
pl/tutorial
hi/tutorial
japost
espost
depost
frpost
thpost
ptpost
rupost
vipost
itpost
kopost
trpost
idpost
plpost
hipost

© Copyright 2021 - 2024 | All Rights Reserved