OpenAPI-TS 项目中查询参数序列化问题的技术解析

背景介绍

OpenAPI-TS 是一个基于 TypeScript 实现的 OpenAPI 规范工具集，其中的 openapi-fetch 模块提供了便捷的 API 请求功能。在实际使用中，开发者发现该模块在处理对象类型的查询参数时，序列化方式与 OpenAPI 3.0 规范默认行为存在差异。

问题本质

OpenAPI 3.0 规范定义了多种参数序列化方式，对于查询参数中的对象类型，规范默认采用"form"样式配合"explode=true"的序列化策略。然而 openapi-fetch 模块当前实现使用了"deepObject"样式，导致生成的查询字符串格式不符合预期。

技术细节分析

规范定义的行为

根据 OpenAPI 规范，当对象作为查询参数时，默认应采用以下序列化方式：

• 样式：form
• 爆炸：true

这意味着一个包含 {role: "admin", firstName: "Alex"} 的对象应该被序列化为 role=admin&firstName=Alex。

当前实现行为

openapi-fetch 模块目前使用"deepObject"样式进行序列化，导致同样的对象被序列化为 id[role]=admin&id[firstName]=Alex 的形式。这种差异可能导致与后端服务的兼容性问题。

解决方案探讨

短期解决方案

开发者可以自定义查询参数序列化器来覆盖默认行为。例如，可以实现一个符合"form+explode"规范的序列化器：

const serializePrimitive = (key, value) => `${key}=${encodeURIComponent(String(value))}`;

const serializeArray = (key, value, serializer) => {
  if (!value.length) return undefined;
  return value
    .map((item) => serializer(key, item))
    .filter(Boolean)
    .join('&');
};

const serializeObject = (value, serializer) => {
  const entries = Object.entries(value).filter(([_, v]) => v !== undefined && v !== null);
  if (!entries.length) return undefined;
  return entries
    .map(([k, v]) => serializer(k, v))
    .filter(Boolean)
    .join('&');
};

export const querySerializer = (q) => {
  const search: string[] = [];
  if (q && typeof q === 'object') {
    for (const [k, v] of Object.entries(q)) {
      const value = queryParamSerializer(k, v);
      if (value) {
        search.push(value);
      }
    }
  }
  return search.join('&');
};

长期改进方向

项目维护者正在考虑以下改进方案：

1. 分离对象和数组的序列化逻辑，提供更细粒度的控制
2. 完善路径参数的序列化支持
3. 在下一个主要版本(0.9.0)中引入这些改进，可能包含一些破坏性变更

最佳实践建议

对于当前版本的用户，建议：

1. 明确了解后端服务期望的参数序列化方式
2. 根据需要实现自定义序列化器
3. 关注项目更新，特别是0.9.0版本的发布
4. 在团队内部统一序列化方式的约定，避免前后端不一致

总结

OpenAPI-TS 项目中的参数序列化问题反映了规范实现与实际应用场景之间的差异。理解这些差异并掌握相应的解决方案，对于构建健壮的API客户端至关重要。随着项目的演进，预计将提供更灵活、更符合规范的序列化机制，进一步简化开发者的工作。