Koa.js - RESTful API

更新于 2025/1/16 14:22:17

要创建移动应用程序、单页应用程序、使用 AJAX 调用并向客户端提供数据，您需要一个 API。构建和命名这些 API 和端点的一种流行架构风格称为 REST(表述性传输状态)。HTTP 1.1 的设计考虑到了 REST 原则。REST 由 Roy Fielding 于 2000 年在其论文 Fielding Dissertations 中引入。

RESTful URI 和方法为我们提供了处理请求所需的几乎所有信息。下表总结了应如何使用各种动词以及如何命名 URI。我们将在最后创建一个电影 API，所以让我们讨论一下它的结构。

方法	URI	详细信息	函数
GET	/movies	安全、可缓存	获取所有电影及其列表详细信息
GET	/movies/1234	安全、可缓存	获取电影 ID 1234 的详细信息
POST	/movies	N/A	使用提供的详细信息创建新电影。响应包含此新创建资源的 URI。
PUT	/movies/1234	幂等	修改电影 ID 1234(如果不存在则创建一个)。响应包含此新创建资源的 URI。
删除	/movies/1234	幂等	如果存在电影 ID 1234，则应将其删除。响应应包含请求的状态。
DELETE 或 PUT	/movies	无效	应为无效。DELETE 和 PUT 应指定它们正在处理的资源。

现在让我们在 Koa 中创建此 API。我们将使用 JSON 作为传输数据格式，因为它在 JavaScript 中易于使用，并且具有许多其他好处。将您的 index.js 文件替换为以下 −

INDEX.JS

var koa = require('koa');
var router = require('koa-router');
var bodyParser = require('koa-body');

var app = koa();

//设置 body 解析中间件
app.use(bodyParser({
    formidable:{uploadDir: './uploads'},
    multipart: true,
    urlencoded: true
}));

//需要我们在 movies.js 中定义的 Router
var movies = require('./movies.js');

//在子路由 /movies 上使用 Router
app.use(movies.routes());

app.listen(3000);

现在我们已经设置好了应用程序，让我们集中精力创建 API。首先设置 movies.js 文件。我们不使用数据库来存储电影，而是将它们存储在内存中，因此每次服务器重新启动时，我们添加的电影都会消失。这可以通过使用数据库或文件(使用 node fs 模块)轻松模拟。

导入 koa-router，创建一个 Router 并使用 module.exports 导出它。

var Router = require('koa-router');
var router = Router({
prefix: '/movies'
}); //为所有路由添加 /movies 前缀

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}
];

//路由将在此处进行

module.exports = router;

GET 路由

定义获取所有电影的 GET 路由。

router.get('/', sendMovies);
function *sendMovies(next){
    this.body = movies;
    Yield next;
}

就是这样。要测试这是否正常工作，请运行您的应用程序，然后打开您的终端并输入 −

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,})', sendMovieWithId);

function *sendMovieWithId(next){
   var ctx = this;
   var currMovie = movies.filter(function(movie){
      if(movie.id == ctx.params.id){
         return true;
      }
   });
   if(currMovie.length == 1){
      this.body = currMovie[0];
   } else {
      this.response.status = 404;//由于未找到电影，将状态设置为 404
      this.body = {message: "Not Found"};
   }
   yield next;
}

这将根据我们提供的 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}

如果您访问无效路由，它将产生无法 GET 错误，而如果您访问具有不存在的 id 的有效路由，它将产生 404 错误。

我们已完成 GET 路由。现在，让我们继续讨论 POST 路由。

POST 路由

使用以下路由处理 POST 数据。

router.post('/', addNewMovie);

function *addNewMovie(next){
   //检查所有字段是否提供且有效:
   if(!this.request.body.name || 
      !this.request.body.year.toString().match(/^[0-9]{4}$/g) || 
      !this.request.body.rating.toString().match(/^[0-9]\.[0-9]$/g)){
      
      this.response.status = 400;
      this.body = {message: "Bad Request"};
   } else {
      var newId = movies[movies.length-1].id+1;
      
      movies.push({
         id: newId,
         name: this.request.body.name,
         year: this.request.body.year,
         rating: this.request.body.rating
      });
      this.body = {message: "New movie created.", location: "/movies/" + newId};
   }
   yield next;
}

这将创建一个新电影并将其存储在 movies 变量中。要测试此路由，请在终端中输入以下内容 −

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

您将获得以下响应 −

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

要测试这是否已添加到 movies 对象，请再次运行 /movies/105 的 get 请求。您将获得以下响应 −

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

让我们继续创建 PUT 和 DELETE 路由。

PUT 路由

PUT 路由几乎与 POST 路由完全相同。我们将指定将要更新/创建的对象 id。按以下方式创建路由 −

router.put('/:id', updateMovieWithId);

function *updateMovieWithId(next){
   //检查所有字段是否提供且有效:
   if(!this.request.body.name || 
      !this.request.body.year.toString().match(/^[0-9]{4}$/g) || 
      !this.request.body.rating.toString().match(/^[0-9]\.[0-9]$/g) ||
      !this.params.id.toString().match(/^[0-9]{3,}$/g)){
      
      this.response.status = 400;
      this.body = {message: "Bad Request"};
   } else {
      //获取具有指定 ID 的电影的索引。
      var updateIndex = movies.map(function(movie){
         return movie.id;
      }).indexOf(parseInt(this.params.id));
      
      if(updateIndex === -1){
         //Movie not found, create new movies.push({
            id: this.params.id,
            name: this.request.body.name,
            year: this.request.body.year,
            rating: this.request.body.rating
         });
         this.body = {message: "New movie created.", location: "/movies/" + this.params.id};    
      } else {
         //更新现有电影
         movies[updateIndex] = {
            id: this.params.id,
            name: this.request.body.name,
            year: this.request.body.year,
            rating: this.request.body.rating
         };
         this.body = {message: "Movie id " + this.params.id + " updated.", location: "/movies/" + this.params.id};
      }
   }
}

此路由将执行我们在上表中指定的功能。如果对象存在，它将使用新详细信息更新对象。如果不存在，它将创建一个新对象。要测试此路由，请使用以下 curl 命令。这将更新现有电影。要创建新电影，只需将 ID 更改为不存在的 ID。

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

响应

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

DELETE 路由

使用以下代码创建删除路由。

router.delete('/:id', deleteMovieWithId);

function *deleteMovieWithId(next){
   var removeIndex = movies.map(function(movie){
      return movie.id;
   }).indexOf(this.params.id); //Gets us the index of movie with given id.
   
   if(removeIndex === -1){
      this.body = {message: "Not found"};
   } else {
      movies.splice(removeIndex, 1);
      this.body = {message: "Movie id " + this.params.id + " removed."};
   }
}

以与测试其他路由相同的方式测试该路由。成功删除后(例如 id 105)，您将得到 −

{message: "Movie id 105 removed."}

最后，我们的 movies.js 文件看起来像 −

var Router = require('koa-router');
var router = Router({
prefix: '/movies'
}); //所有路由都以 /movies 为前缀
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
router.get('/', sendMovies);
router.get('/:id([0-9]{3,})', sendMovieWithId);
router.post('/', addNewMovie);
router.put('/:id', updateMovieWithId);
router.delete('/:id', deleteMovieWithId);

function *deleteMovieWithId(next){
   var removeIndex = movies.map(function(movie){
      return movie.id;
   }).indexOf(this.params.id); //获取具有指定 ID 的电影的索引。
   
   if(removeIndex === -1){
      this.body = {message: "Not found"};
   } else {
      movies.splice(removeIndex, 1);
      this.body = {message: "Movie id " + this.params.id + " removed."};
   }
}

function *updateMovieWithId(next) {
   //检查所有字段是否提供且有效:
   if(!this.request.body.name ||
      !this.request.body.year.toString().match(/^[0-9]{4}$/g) ||
      !this.request.body.rating.toString().match(/^[0-9]\.[0-9]$/g) ||
      !this.params.id.toString().match(/^[0-9]{3,}$/g)){
      
      this.response.status = 400;
      this.body = {message: "Bad Request"};
   } else {
      //获取具有指定 ID 的电影的索引。
      var updateIndex = movies.map(function(movie){
         return movie.id;
      }).indexOf(parseInt(this.params.id));
      
      if(updateIndex === -1){
         //未找到影片，创建新影片
         movies.push({
            id: this.params.id,
            name: this.request.body.name,
            year: this.request.body.year,
            rating: this.request.body.rating
         });
         this.body = {message: "New movie created.", location: "/movies/" + this.params.id};
      } else {
         //更新现有电影
            movies[updateIndex] = {
            id: this.params.id,
            name: this.request.body.name,
            year: this.request.body.year,
            rating: this.request.body.rating
         };
         this.body = {message: "Movie id " + this.params.id + " updated.", 
            location: "/movies/" + this.params.id};
      }
   }
}

function *addNewMovie(next){
   //检查所有字段是否提供且有效:
   if(!this.request.body.name ||
      !this.request.body.year.toString().match(/^[0-9]{4}$/g) ||
      !this.request.body.rating.toString().match(/^[0-9]\.[0-9]$/g)){
      
      this.response.status = 400;
      this.body = {message: "Bad Request"};
   } else {
      var newId = movies[movies.length-1].id+1;
      
      movies.push({
         id: newId,
         name: this.request.body.name,
         year: this.request.body.year,
         rating: this.request.body.rating
      });
      this.body = {message: "New movie created.", location: "/movies/" + newId};
   }
   yield next;
}
function *sendMovies(next){
   this.body = movies;
   yield next;
}
function *sendMovieWithId(next){
   var ctx = this
   
   var currMovie = movies.filter(function(movie){
      if(movie.id == ctx.params.id){
         return true;
      }
   });
   if(currMovie.length == 1){
      this.body = currMovie[0];
   } else {
      this.response.status = 404;//将状态设置为 404，因为未找到电影
      this.body = {message: "Not Found"};
   }
   yield next;
}
module.exports = router;

这样就完成了我们的 REST API。现在，您可以使用这种简单的架构风格和 Koa 创建更复杂的应用程序。

❮ Koa.js 数据库 Koa.js 日志记录 ❯