Orval项目中日期类型Mock数据的处理技巧

2025-06-17 08:49:13作者：田桥桑Industrious

orval is able to generate client with appropriate type-signatures (TypeScript) from any valid OpenAPI v3 or Swagger v2 specification, either in yaml or json formats. 🍺

项目地址：https://gitcode.com/gh_mirrors/or/orval

在Orval项目中，当开发者配置了useDates: true和mock: true时，会遇到日期类型数据Mock的问题。本文将深入分析这一问题，并提供专业的技术解决方案。

问题背景

Orval是一个强大的OpenAPI客户端生成工具，它可以根据API规范自动生成类型安全的客户端代码。当启用日期类型支持(useDates: true)时，Orval会将API规范中的日期字段转换为JavaScript的Date对象。同时，启用Mock功能(mock: true)会为这些字段生成模拟数据。

然而，当前版本(6.31.0)中存在一个关键问题：Mock数据生成器虽然使用了Faker库来创建Date对象，但在最终输出时却将这些Date对象转换成了字符串，这与useDates配置的预期行为不符。

技术影响

这个问题会在以下场景中产生影响：

单元测试：当使用Mock数据进行测试时，类型不匹配会导致测试失败
开发环境：前端组件期望接收Date对象，但实际收到的是字符串
表单数据处理：使用formData选项时，Date对象需要正确转换为字符串

解决方案

1. Mock数据修复

通过配置覆盖，可以确保Mock数据生成正确的Date对象：

module.exports = {
  api: {
    mock: true,
    override: {
      useDates: true,
      mock: {
        format: {
          date: () => faker.date.recent(),
          'date-time': () => faker.date.recent(),
        },
      },
    },
  }
};

这个配置告诉Orval在生成Mock数据时，对于date和date-time格式的字段，直接使用Faker生成的Date对象，而不是转换为字符串。

2. 表单数据处理

对于使用formData的场景，需要自定义表单数据处理逻辑，确保Date对象被正确转换为ISO字符串：

export const customFormData = <Body>(body: Body): FormData => {
  const formData = new FormData()

  Object.entries(body).forEach(([key, value]) => {
    if (value instanceof Date) {
      value = value.toISOString()
    }
    formData.append(key, value)
  })

  return formData
}

然后在Orval配置中指定使用这个自定义的表单数据处理函数：

module.exports = {
  api: {
    mock: true,
    override: {
      useDates: true,
      formData: {
        path: './src/api/custom-form-data.ts',
        name: 'customFormData',
      },
    },
  }
};