使用 Hapi 构建一个 RESTful API-JavaScript中文网-JavaScript教程资源分享门户

简介

Hapi 是一个 Node.js 的 Web 框架，它提供了一套完整的工具集，可以帮助开发者快速构建高质量的 Web 应用程序和 RESTful API。Hapi 的设计理念是高度可配置和可扩展，因此它非常适合用于构建大型和复杂的 Web 应用程序。

本文将介绍如何使用 Hapi 构建一个简单的 RESTful API。我们将使用 Hapi 的基本功能来创建一个具有 CRUD（创建、读取、更新、删除）操作的 API。我们会使用 MongoDB 作为数据存储，并且会使用 Mongoose 进行数据模型的定义和操作。

准备工作

在开始之前，我们需要准备一些工具和资源：

Node.js 和 npm
MongoDB 数据库
Postman（用于测试 API）

安装 Node.js 和 npm 的方法可以参考官方文档。MongoDB 的安装方法也可以参考官方文档。Postman 可以在官网上下载安装。

创建项目

我们首先创建一个空的 Node.js 项目，并且安装 Hapi 和 Mongoose：

mkdir hapi-api
cd hapi-api
npm init -y
npm install hapi mongoose

编写代码

我们先创建一个 server.js 文件，并且在其中编写代码。以下是完整的代码：

// javascriptcn.com 代码示例
const Hapi = require('hapi')
const mongoose = require('mongoose')

// 连接数据库
mongoose.connect('mongodb://localhost/hapi-api', { useNewUrlParser: true })

// 定义数据模型
const Todo = mongoose.model('Todo', {
  title: String,
  completed: Boolean
})

// 创建服务器
const server = Hapi.server({
  host: 'localhost',
  port: 3000
})

// 创建路由
server.route([
  {
    method: 'GET',
    path: '/todos',
    handler: async (request, h) => {
      const todos = await Todo.find()
      return todos
    }
  },
  {
    method: 'POST',
    path: '/todos',
    handler: async (request, h) => {
      const { title, completed } = request.payload
      const todo = new Todo({ title, completed })
      await todo.save()
      return todo
    }
  },
  {
    method: 'PUT',
    path: '/todos/{id}',
    handler: async (request, h) => {
      const { id } = request.params
      const { title, completed } = request.payload
      const todo = await Todo.findByIdAndUpdate(id, { title, completed }, { new: true })
      return todo
    }
  },
  {
    method: 'DELETE',
    path: '/todos/{id}',
    handler: async (request, h) => {
      const { id } = request.params
      const todo = await Todo.findByIdAndDelete(id)
      return todo
    }
  }
])

// 启动服务器
const start = async () => {
  await server.start()
  console.log(`Server running at: ${server.info.uri}`)
}

start()

代码中的注释已经解释了每一部分的作用，下面我们简要介绍一下：

连接数据库：使用 Mongoose 连接 MongoDB 数据库。
定义数据模型：定义一个 Todo 模型，它包含 title 和 completed 两个字段。
创建服务器：使用 Hapi 创建一个服务器，监听 localhost:3000。
创建路由：创建四个路由，分别对应 GET、POST、PUT 和 DELETE 请求，实现了 CRUD 操作。
启动服务器：启动服务器，输出服务器的地址。

测试 API

我们使用 Postman 来测试 API。首先我们需要启动服务器：

node server.js

然后我们可以使用 Postman 发送请求来测试 API。以下是一些测试请求的示例：

GET /todos：获取所有的 Todo。

请求：

GET http://localhost:3000/todos

响应：

// javascriptcn.com 代码示例
[
  {
    "_id": "5d5c6fbbf7f5c6b2e2b39d9b",
    "title": "Buy milk",
    "completed": false,
    "__v": 0
  },
  {
    "_id": "5d5c6fcdf7f5c6b2e2b39d9c",
    "title": "Do laundry",
    "completed": true,
    "__v": 0
  }
]

POST /todos：创建一个新的 Todo。

请求：

POST http://localhost:3000/todos
Content-Type: application/json

{
  "title": "Clean room",
  "completed": false
}

响应：

{
  "_id": "5d5c6ffa4c4b3cb3b3d9b69e",
  "title": "Clean room",
  "completed": false,
  "__v": 0
}

PUT /todos/{id}：更新一个 Todo。

请求：

PUT http://localhost:3000/todos/5d5c6ffa4c4b3cb3b3d9b69e
Content-Type: application/json

{
  "title": "Clean room",
  "completed": true
}

响应：

{
  "_id": "5d5c6ffa4c4b3cb3b3d9b69e",
  "title": "Clean room",
  "completed": true,
  "__v": 0
}

DELETE /todos/{id}：删除一个 Todo。

请求：

DELETE http://localhost:3000/todos/5d5c6ffa4c4b3cb3b3d9b69e

响应：

{
  "_id": "5d5c6ffa4c4b3cb3b3d9b69e",
  "title": "Clean room",
  "completed": true,
  "__v": 0
}

总结

在本文中，我们使用 Hapi 和 Mongoose 构建了一个简单的 RESTful API，实现了 CRUD 操作。我们介绍了 Hapi 和 Mongoose 的基本用法，并且使用 Postman 进行了 API 的测试。希望本文对读者有所帮助，可以作为学习和使用 Hapi 的参考。

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/65722f17d2f5e1655db04b74