如何使用 Hapi 提供 RESTful API

在现代应用程序领域，RESTful API 已成为 Web 应用程序构建不可或缺的基础设施之一。RESTful API 通过使用 HTTP 协议的可扩展性和灵活性，为 Web 应用程序提供了一种简单、可靠和可扩展的组件通信机制。在前端开发领域中，Hapi 是一个受欢迎的开源 Web 框架，它提供了一种简单、可靠和可扩展的方式来构建 RESTful API。本文将介绍如何使用 Hapi 创建 RESTful API，并提供示例代码和深度学习指导。

Hapi 框架简介

Hapi 是一个用于构建 Node.js Web 应用程序的框架。它提供了一个强大的插件系统，可以轻松地扩展和定制应用程序的功能。Hapi 的目标是提供一种简单、可靠和可扩展的方式来构建 Web 应用程序。

Hapi 的特点包括：

• 基于插件架构的可扩展性。
• 支持路由、请求处理和响应。
• 集成了著名的 Joi 数据校验库。
• 集成了好用的 MVC、Auth、Logging 等功能。
• 可以轻松地扩展和定制应用程序的功能。

使用 Hapi 创建 RESTful API

在 Hapi 中创建 RESTful API 非常简单。API 的主要构造块是路由。Hapi 中的路由定义了请求 URL 和 HTTP 方法之间的映射关系，这是创建任何 API 都需要遵循的基本原则。以下是使用 Hapi 创建 RESTful API 的简单示例：

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

const init = async () => {

    const server = Hapi.server({
        port: 3000,
        host: 'localhost'
    });

    server.route({
        method: 'GET',
        path: '/',
        handler: (request, h) => {
            return 'Hello, world!';
        }
    });

    await server.start();
    console.log('Server running on %s', server.info.uri);
};

process.on('unhandledRejection', (err) => {
    console.log(err);
    process.exit(1);
});

init();

在这个示例中，我们创建了一个简单的 RESTful API，它监听 3000 端口，并返回 Hello, world! 响应。我们定义了一个路由，该路由将 HTTP GET 请求映射到 / URL，并返回字符串响应。

路由定义和参数解析

创建路由是定义 RESTful API 的核心部分。在 Hapi 中，路由定义基于 HTTP 方法（GET、POST、PUT、DELETE 等）和请求路径。下面是一个简单的 Hapi 路由定义的示例：

// javascriptcn.com 代码示例
server.route({
    method: 'GET',
    path: '/api/books/{id}',
    handler: (request, h) => {
        const id = request.params.id;
        const book = books.find((b) => b.id === id);
        if (!book) {
            return h.response().code(404);
        }
        return book;
    }
});

在这个示例中，我们创建了一个 GET 方法路由，该路由将 HTTP GET 请求映射到 /api/books/{id} URL。在请求处理程序中，我们解析了 id 参数的值，并根据该值查找匹配的书籍对象。如果找到了书籍对象，则会将它作为响应返回。否则，我们返回一个空响应并使用 HTTP 404 状态码。

使用 Joi 进行数据校验

在编写任何应用程序时，数据校验是一个必不可少的过程。在 Hapi 中，Joi 是一个著名的数据校验库，它提供了一种清晰、可读、可维护的方式来检查输入数据是否符合预期。下面是一个使用 Joi 进行数据校验的示例：

// javascriptcn.com 代码示例
const Joi = require('joi');

server.route({
    method: 'POST',
    path: '/api/books',
    handler: (request, h) => {
        const book = request.payload;
        books.push(book);
        return h.response(book).code(201);
    },
    options: {
        validate: {
            payload: Joi.object({
                title: Joi.string().required(),
                author: Joi.string().required(),
                price: Joi.number().required()
            })
        }
    }
});

在这个示例中，我们创建了一个 POST 方法路由，该路由将 HTTP POST 请求映射到 /api/books URL。在请求处理程序中，我们从 payload 解析了 book 对象，并将它添加到 books 数组中。然后我们返回一个带有创建的书籍对象的响应，并使用 HTTP 201 状态码。在选项中，我们使用了 Joi 对 payload 进行了校验，并确保了 title、author 和 price 属性的值都是必需的。

使用插件扩展 Hapi 功能

Hapi 提供了一种强大的插件系统，可用于扩展和定制应用程序。插件可以添加新的功能、修改现有的功能，以及自定义请求处理程序和响应。下面是使用 Hapi 插件创建 RESTful API 的示例：

// javascriptcn.com 代码示例
const Hapi = require('@hapi/hapi');
const HapiSwagger = require('hapi-swagger');
const Vision = require('vision');
const Inert = require('inert');
const Pack = require('./package');

const init = async () => {

    const server = Hapi.server({
        port: 3000,
        host: 'localhost'
    });

    await server.register([
        Inert,
        Vision,
        {
            plugin: HapiSwagger,
            options: {
                info: {
                    title: 'My API Documentation',
                    version: Pack.version
                }
            }
        }
    ]);

    server.route([
        {
            method: 'GET',
            path: '/api/books',
            handler: (request, h) => {
                return books;
            }
        },
        {
            method: 'POST',
            path: '/api/books',
            handler: (request, h) => {
                const book = request.payload;
                books.push(book);
                return h.response(book).code(201);
            },
            options: {
                validate: {
                    payload: Joi.object({
                        title: Joi.string().required(),
                        author: Joi.string().required(),
                        price: Joi.number().required()
                    })
                }
            }
        }
    ]);

    await server.start();
    console.log(`Server running at: ${server.info.uri}`);
};

process.on('unhandledRejection', (err) => {
    console.log(err);
    process.exit(1);
});

init();

在这个示例中，我们添加了三个插件：Inert、Vision 和 HapiSwagger。Inert 和 Vision 用于支持静态文件服务器和模板引擎，HapiSwagger 用于支持自动生成 API 文档。我们还定义了两个路由，一个用于返回所有书籍列表，另一个用于创建新书籍。我们使用 Joi 对 payload 进行了校验，并使用 HapiSwagger 插件自动生成了文档。

总结

使用 Hapi 创建 RESTful API 是一种简单、可靠和可扩展的方式，它提供了一种简单、可靠和可扩展的方式来构建 Web 应用程序。在本文中，我们介绍了 Hapi 框架的基础知识、路由定义和参数解析、数据校验和插件扩展等内容，并提供了相应的示例代码和深度学习指导。现在，您可以开始构建自己的 RESTful API，把 Hapi 的强大功能和插件系统应用到实践中！

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