在构建 Web 应用程序时，API 设计是一个至关重要的环节。Hapi 是一个流行的 Node.js Web 框架，它在 API 设计方面提供了许多最佳实践。本文将介绍在 Hapi 中 API 设计的最佳实践，帮助开发人员编写出可靠和可扩展的 API。
使用路由的方式
在 Hapi 中，路由是负责将 HTTP 请求映射到它们的处理程序。通过使用路由，我们可以轻松地为应用程序添加新的端点。为了定义路由，我们可以使用 server.route() 方法。下面是一个简单的 Hapi 路由：
server.route({
method: 'GET',
path: '/hello',
handler: (request, h) => {
return 'Hello World';
}
});在上面的路由中，我们定义了一个名为 /hello 的 GET 端点，它的处理程序简单地返回了一个字符串。我们可以定义各种类型的路由，包括 HTTP 方法路由、URL 参数路由和请求体验证路由。
使用验证和鉴权
在构建 API 时，鉴权和验证是必不可少的。Hapi 允许为路由定义特定的请求验证和响应验证。这样做可以大大增强 API 的安全性和可靠性。下面是一个使用 Basic Authentication 的 Hapi 路由：
-- -------------------- ---- -------
--------------
------- ------
----- -----------
-------- -
----- --------
-------- --------- -- -- -
------ -------- ------
-
-
---在上面的路由中，我们为 /private 路由添加了基本身份验证。这意味着请求将包含一个用户名和密码，并且在成功身份验证后才会到达处理程序。Hapi 还支持许多其他的身份验证和授权机制，例如 JSON Web Tokens、OAuth 和 Hawk。
使用插件和 Middleware
在构建 Web 应用程序时，许多常见的需求都可以通过使用插件和 middleware 来解决。插件和 middleware 可以使代码更加模块化，易于维护和测试。
在 Hapi 中，插件是以统一的方式包含在应用程序中的可重用功能块。下面是一个使用 inert 插件的 Hapi 路由，该插件允许我们提供静态文件：
-- -------------------- ---- -------
----- ----- - -----------------
----- -----------------------
--------------
------- ------
----- ---------------------
-------- -
----- -------------------
-
---在上面的路由中，我们安装了 inert 插件并使用 await server.register(Inert) 语句进行了注册。接下来我们为 /public/index.html 路由定义了一个正常的路由处理程序，并将其指向静态文件的路径。inert 插件负责将请求的文件发送到客户端。在实际应用中，在路由处理程序之前添加一个中间件功能，可以拦截请求、处理请求，或者对请求进行更改。
结论
在本文中，我们讨论了在 Hapi 中设计高质量 API 的最佳做法，包括使用路由、验证和鉴权、插件和 middleware。这些实践有助于保持代码的一致性、可读性和可维护性。Hapi 的功能使得构建健壮的 API 更容易，也使得我们可以专注于我们的应用程序的业务逻辑。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67126326ad1e889fe204ecaf