在NEXT.js中使用next-joi进行API路由验证

NEXT.js项目中,使用next-joi包可以轻松实现API路由的验证功能。以下是详细的安装与使用说明:

1. 安装与配置

  • 使用 yarn add next-joi 命令安装next-joi包。
  • 注意:该包不包括Joi库,因此需要单独安装。

2. 验证功能概述

next-joi 验证功能主要用于检查传入的请求是否符合指定的验证模式。若请求不符合预设架构,它会自动中止并返回 400 BAD REQUEST 响应。

  • 自定义错误处理:可以通过向主工厂函数传递 onValidationError 函数自定义错误处理。

3. 实例代码

lib/middlewares/validation.ts 中进行如下配置:

import withJoi from "next-joi";

export default withJoi({
    onValidationError: (_, res) => {
        return res.status(400).end();
    },
});

该代码将返回默认的 400 错误响应,若请求未通过验证。

zip 文件大小:110.67KB