schema-error-msg-cn.md 5.9 KB


description: "给schema加上中文错误提示"

为每个验证字段添加 message 属性的中文错误提示

示例:

// 基础用户 schema(包含所有字段)
export const UserSchema = z.object({
  id: z.number().int().positive().openapi({ description: '用户ID' }),
  username: z.string().min(3, '用户名至少3个字符').max(255, '用户名最多255个字符').openapi({
    example: 'admin',
    description: '用户名,3-255个字符'
  }),
  password: z.string().min(6, '密码至少6位').max(255, '密码最多255位').openapi({
    example: 'password123',
    description: '密码,最少6位'
  }),
  phone: z.string().max(255, '手机号最多255个字符').nullable().openapi({
    example: '13800138000',
    description: '手机号'
  }),
  email: z.email('请输入正确的邮箱格式').max(255, '邮箱最多255个字符').nullable().openapi({
    example: 'user@example.com',
    description: '邮箱'
  }),
  nickname: z.string().max(255, '昵称最多255个字符').nullable().openapi({
    example: '昵称',
    description: '用户昵称'
  }),
  name: z.string().max(255, '姓名最多255个字符').nullable().openapi({
    example: '张三',
    description: '真实姓名'
  }),
  avatarFileId: z.number().int().positive().nullable().openapi({
    example: 1,
    description: '头像文件ID'
  }),
  avatarFile: z.object({
    id: z.number().int().positive().openapi({ description: '文件ID' }),
    name: z.string().max(255).openapi({ description: '文件名', example: 'avatar.jpg' }),
    fullUrl: z.string().openapi({ description: '文件完整URL', example: 'https://example.com/avatar.jpg' }),
    type: z.string().nullable().openapi({ description: '文件类型', example: 'image/jpeg' }),
    size: z.number().nullable().openapi({ description: '文件大小(字节)', example: 102400 })
  }).nullable().optional().openapi({
    description: '头像文件信息'
  }),
  openid: z.string().max(255).nullable().optional().openapi({
    example: 'oABCDEFGH123456789',
    description: '微信小程序openid'
  }),
  unionid: z.string().max(255).nullable().optional().openapi({
    example: 'unionid123456789',
    description: '微信unionid'
  }),
  registrationSource: z.string().max(20).default('web').openapi({
    example: 'miniapp',
    description: '注册来源: web, miniapp'
  }),
  isDisabled: z.number().int().min(0).max(1).default(DisabledStatus.ENABLED).openapi({
    example: DisabledStatus.ENABLED,
    description: '是否禁用(0:启用,1:禁用)'
  }),
  isDeleted: z.number().int().min(0).max(1).default(DeleteStatus.NOT_DELETED).openapi({
    example: DeleteStatus.NOT_DELETED,
    description: '是否删除(0:未删除,1:已删除)'
  }),
  roles: z.array(RoleSchema).optional().openapi({
    example: [
      {
        id: 1,
        name: 'admin',
        description: '管理员',
        permissions: ['user:create'],
        createdAt: new Date(),
        updatedAt: new Date()
      }
    ],
    description: '用户角色列表'
  }),
  createdAt: z.coerce.date().openapi({ description: '创建时间' }),
  updatedAt: z.coerce.date().openapi({ description: '更新时间' })
});

// 创建用户请求 schema
export const CreateUserDto = z.object({
  username: z.string().min(3, '用户名至少3个字符').max(255, '用户名最多255个字符').openapi({
    example: 'admin',
    description: '用户名,3-255个字符'
  }),
  password: z.string().min(6, '密码至少6位').max(255, '密码最多255位').openapi({
    example: 'password123',
    description: '密码,最少6位'
  }),
  phone: z.string().max(255, '手机号最多255个字符').nullable().optional().openapi({
    example: '13800138000',
    description: '手机号'
  }),
  email: z.email('请输入正确的邮箱格式').max(255, '邮箱最多255个字符').nullable().optional().openapi({
    example: 'user@example.com',
    description: '邮箱'
  }),
  nickname: z.string().max(255, '昵称最多255个字符').nullable().optional().openapi({
    example: '昵称',
    description: '用户昵称'
  }),
  name: z.string().max(255, '姓名最多255个字符').nullable().optional().openapi({
    example: '张三',
    description: '真实姓名'
  }),
  avatarFileId: z.number().int().positive().nullable().optional().openapi({
    example: 1,
    description: '头像文件ID'
  }),
  isDisabled: z.number().int().min(0, '状态值只能是0或1').max(1, '状态值只能是0或1').default(DisabledStatus.ENABLED).optional().openapi({
    example: DisabledStatus.ENABLED,
    description: '是否禁用(0:启用,1:禁用)'
  })
});

// 更新用户请求 schema
export const UpdateUserDto = z.object({
  username: z.string().min(3, '用户名至少3个字符').max(255, '用户名最多255个字符').optional().openapi({
    example: 'admin',
    description: '用户名,3-255个字符'
  }),
  password: z.string().min(6, '密码至少6位').max(255, '密码最多255位').optional().openapi({
    example: 'password123',
    description: '密码,最少6位'
  }),
  phone: z.string().max(255, '手机号最多255个字符').nullable().optional().openapi({
    example: '13800138000',
    description: '手机号'
  }),
  email: z.email('请输入正确的邮箱格式').max(255, '邮箱最多255个字符').nullable().optional().openapi({
    example: 'user@example.com',
    description: '邮箱'
  }),
  nickname: z.string().max(255, '昵称最多255个字符').nullable().optional().openapi({
    example: '昵称',
    description: '用户昵称'
  }),
  name: z.string().max(255, '姓名最多255个字符').nullable().optional().openapi({
    example: '张三',
    description: '真实姓名'
  }),
  avatarFileId: z.number().int().positive().nullable().optional().openapi({
    example: 1,
    description: '头像文件ID'
  }),
  isDisabled: z.number().int().min(0, '状态值只能是0或1').max(1, '状态值只能是0或1').optional().openapi({
    example: DisabledStatus.ENABLED,
    description: '是否禁用(0:启用,1:禁用)'
  })
});