# @fastify/response-validation 中文文档

规范地址：https://npmcn.com/package/%40fastify/response-validation/

版本：3\.0\.5
npm 元数据更新时间：2026-10-18T12:30:39.060Z
中文译文更新时间：2026-11-14T11:24:34.530Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40fastify/response-validation
原文对照：https://npmcn.com/package/%40fastify/response-validation/?lang=original
项目主页：https://github.com/fastify/fastify-response-validation#readme
源码仓库：https://github.com/fastify/fastify-response-validation

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：38.5 kB，15 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2022-04-27T15:30:36.941Z
- 最新版本发布：2026-10-09T15:11:14.851Z
- 近 30 天下载量：52127（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：19（近 12 个月 2 个）

## 中文简介

一个简单的插件,可以进行快速化的响应验证.

## 安装

```sh
npm install @fastify/response-validation
```

也可以使用：`pnpm add @fastify/response-validation`、`yarn add @fastify/response-validation`、`bun add @fastify/response-validation`

## README

# @ fastify/ 应答- 验证

[![CI](https://github.com/fastify/fastify-response-validation/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/fastify/fastify-response-validation/actions/workflows/ci.yml) [![NPM version](https://img.shields.io/npm/v/@fastify/response-validation.svg?style=flat)](https://www.npmjs.com/package/@fastify/response-validation) [![neostandard javascript style](https://img.shields.io/badge/code_style-neostandard-brightgreen?style=flat)](https://github.com/neostandard/neostandard)

一个简单的插件,可以进行快速化的响应验证. 这个插件的使用会降低你的整体性能,因此我们建议只在开发期间使用.

## 安装

```
npm i @fastify/response-validation
```

## 使用量

您只需要注册插件, 并启用响应验证 :

```js
import fastify from 'fastify'

const app = fastify()

await app.register(require('@fastify/response-validation'))

app.route({
  method: 'GET',
  path: '/',
  schema: {
    response: {
      '2xx': {
        type: 'object',
        properties: {
          answer: { type: 'number' }
        }
      }
    }
  },
  handler: async (req, reply) => {
    return { answer: '42' }
  }
})

app.inject({
  method: 'GET',
  path: '/'
}, (err, res) => {
  if (err) throw err
  console.log(res.payload)
})
```

不同内容类型的答复得到 `@fastify/response-validation`, (中文(简体) ), `@fastify/swagger`,以及 `fastify`请使用 `content` 对于响应,否则将无法快速化,无法汇编计划:

```js
{
  response: {
    200: {
      description: 'Description and all status-code based properties are working',
      content: {
        'application/json': {
          schema: {
            name: { type: 'string' },
            image: { type: 'string' },
            address: { type: 'string' }
          }
        },
        'application/vnd.v1+json': {
          schema: {
            fullName: { type: 'string' },
            phone: { type: 'string' }
          }
        }
      }
    }
  }
}
```

如果您想要推翻默认 [页:1](https://www.npmjs.com/package/ajv) 配置,您可以通过使用 `ajv` 选项 :

```js
// Default configuration:
//    coerceTypes: false
//    useDefaults: true
//    removeAdditional: true
//    allErrors: true

import responseValidator from '@fastify/response-validation'

// ... App setup

await fastify.register(responseValidator, {
  ajv: {
    coerceTypes: true
  }
})
```

您也可以通过 ajv 实例

```js
// Default configuration:
//    coerceTypes: false
//    useDefaults: true
//    removeAdditional: true
//    allErrors: true

import responseValidator from '@fastify/response-validation'
import Ajv from 'ajv'

// ... App setup

const ajv = new Ajv()
await fastify.register(responseValidator, { ajv })
```

默认情况下,在每个定义了响应策略的路径上都启用了响应验证. 如果需要的话,您可以一起禁用 `responseValidation: false`数字 :

```js
import responseValidator from '@fastify/response-validation'

// ... App setup
await fastify.register(responseValidator, {
  responseValidation: false
})
```

或者,您可以禁用同一选项的特定路径 :

```js
fastify.route({
  method: 'GET',
  path: '/',
  responseValidation: false,
  schema: {
    response: {
      '2xx': {
        type: 'object',
        properties: {
          answer: { type: 'number' }
        }
      }
    }
  },
  handler: async (req, reply) => {
    return { answer: '42' }
  }
})
```

## 插件

您也可以通过添加新的 ajv 插件来扩展嵌入在此验证符中的 ajv 实例的功能 .

```js
fastify.register(require('fastify-response-validation'), {
  ajv: {
    plugins: [
      require('ajv-formats'),
      [require('ajv-errors'), { singleError: false }]
      // Usage: [plugin, pluginOptions] - Plugin with options
      // Usage: plugin - Plugin without options
    ]
  }
})
```

## 错误

此插件出错为 :

-   `FST_RESPONSE_VALIDATION_FAILED_VALIDATION`: 当答复不符合所提供的计划时, 就会发出这个错误 .
    
-   `FST_RESPONSE_VALIDATION_SCHEMA_NOT_DEFINED`: 当没有JSON schema可用以验证响应时, 此错误会被释放 .
    

## 许可证

[麻省理工学院](https://npmcn.com/package/%40fastify/response-validation/LICENSE)

## 常见问题

### @fastify/response-validation 是什么？

一个简单的插件,可以进行快速化的响应验证\.

### 如何安装 @fastify/response-validation？

在项目目录运行 npm install @fastify/response-validation，或使用 pnpm add / yarn add / bun add。

### @fastify/response-validation 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @fastify/response-validation 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @fastify/response-validation 可以商用吗？

@fastify/response-validation 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @fastify/response-validation 的下载量有多少？

根据 npm 官方下载统计，@fastify/response-validation 在 2026/10/15 – 2026/11/13 这 30 天内被下载 52,127 次，日均约 1,738 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @fastify/response-validation 还在维护吗？

最新版本 3\.0\.5 发布于 2026/10/09（1 个月前）；至今共发布 19 个版本，其中过去 12 个月发布了 2 个；首次发布于 2022/04/27。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。