RESTful API 是现代 Web 开发中常见的一种技术，通过 API 的方式让前端和后端相互交互。实现 RESTful API 有很多种方式，而 HapiJS 是其中一种比较受欢迎的框架。本文将介绍如何使用 HapiJS 实现一个 RESTful API，并提供示例代码。
什么是 HapiJS
HapiJS 是 NodeJS 的一个 Web 开发框架，它提供了很多强大的功能，比如路由、中间件、日志处理、输入验证等等。HapiJS 的主要特点是易于使用和高度可扩展，它的代码结构很清晰，让开发者更容易理解和维护。
实现 RESTful API
下面我们来看如何使用 HapiJS 实现一个简单的 RESTful API。假设我们需要实现一个博客系统，其中有两个资源：文章和标签。文章包括标题和内容，标签包括名称和描述。我们需要提供以下 RESTful API：
获取文章列表
GET /api/articles
获取指定文章
GET /api/articles/:id
创建文章
POST /api/articles
请求体数据格式：
{ "title": "文章标题", "content": "文章内容" }
更新文章
PUT /api/articles/:id
请求体数据格式：
{ "title": "文章标题", "content": "文章内容" }
删除文章
DELETE /api/articles/:id
获取标签列表
GET /api/tags
获取指定标签
GET /api/tags/:id
创建标签
POST /api/tags
请求体数据格式：
{ "name": "标签名称", "description": "标签描述" }
更新标签
PUT /api/tags/:id
请求体数据格式：
{ "name": "标签名称", "description": "标签描述" }
删除标签
DELETE /api/tags/:id
以上就是我们需要提供的 API 列表。
实现过程
首先，我们需要安装 HapiJS：
npm install @hapi/hapi
然后，创建一个名为 app.js 的文件，并加入以下代码：
-- -------------------- ---- ------- ----- ---- - --------------------- ----- ---- - ----- -- -- - ----- ------ - ------------- ----- ----- ----- ----------- -- ----- -------------- ------------------- ------- -- ---- ---------------- - -------------------------------- ----- -- - ---------------- --------------- -- ------展开代码
以上代码创建了一个名为 server 的服务器对象，并监听了本地 3000 端口。我们可以运行 node app.js 来启动这个服务器。
接下来，我们需要添加路由来实现我们需要的 API。在 app.js 文件中添加以下代码：
-- -------------------- ---- ------- -------------- ------- ------ ----- ---------------- -------- --------- -- -- - -- ---- --- ------- -------- ---- ---- - -- -------------- ------- ------ ----- --------------------- -------- --------- -- -- - -- ---- --- ------- - -------- ------- ---- ---- - -- -------------- ------- ------- ----- ---------------- -------- --------- -- -- - -- ---- --- -------- -- ------- ---- ---- -- -------- - --------- - -------- ------------ ------ ------------------------ -------- ----------------------- -- - - -- -------------- ------- ------ ----- --------------------- -------- --------- -- -- - -- ---- --- -------- -- ------- ---- ---- -- -------- - --------- - -------- ------------ ------ ------------------------ -------- ----------------------- -- - - -- -------------- ------- --------- ----- --------------------- -------- --------- -- -- - -- ---- --- -------- -- ------- ---- ---- - -- -------------- ------- ------ ----- ------------ -------- --------- -- -- - -- ---- --- ------- ---- ---- ---- - -- -------------- ------- ------ ----- ----------------- -------- --------- -- -- - -- ---- --- ------- - -------- --- ---- ---- - -- -------------- ------- ------- ----- ------------ -------- --------- -- -- - -- ---- --- -------- - --- ---- ---- -- -------- - --------- - -------- ------------ ----- ------------------------ ------------ ----------------------- -- - - -- -------------- ------- ------ ----- ----------------- -------- --------- -- -- - -- ---- --- -------- - --- ---- ---- -- -------- - --------- - -------- ------------ ----- ------------------------ ------------ ----------------------- -- - - -- -------------- ------- --------- ----- ----------------- -------- --------- -- -- - -- ---- --- -------- - --- ---- ---- - --展开代码
以上代码定义了所有需要的 API，并使用了 HapiJS 的路由机制。其中，handler 是处理请求的函数，需要开发者自己实现。而 options.validate 是使用了 HapiJS 的验证中间件，用于验证请求体的数据格式。我们需要在顶部添加 const Joi = require('joi') 来引入验证中间件。
示例代码
完整的代码可以在 GitHub 上查看：https://github.com/KushibikiMashu/hapijs-restful-api。在这个示例代码中，我使用了 MongoDB 作为数据库来存储文章和标签的数据。对于 MongoDB 的使用方法，读者可以自行学习。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67b96824306f20b3a67bed84
