openapi-typescript 项目中 multipart/form-data 边界参数问题解析

问题背景

在使用 openapi-typescript 项目中的 openapi-fetch 库时，开发者遇到了一个关于 multipart/form-data 请求的边界参数问题。当从 0.8.x 版本升级到 0.12.x 版本后，原本正常工作的文件上传功能开始报错，提示"Content-Type of type multipart must include a boundary parameter"。

技术原理

multipart/form-data 是一种用于在 HTTP 请求中发送二进制数据的编码类型，特别适合文件上传场景。这种编码类型需要在 Content-Type 头中指定一个 boundary 参数，用于分隔请求体中的不同部分。

在浏览器环境中，当使用 FormData 对象发送请求时，浏览器会自动处理以下事项：

1. 设置正确的 Content-Type 头
2. 生成唯一的 boundary 分隔符
3. 将请求体按照 boundary 分隔符格式化为正确的 multipart 格式

问题分析

在旧版本(0.8.x)的 openapi-fetch 中，库会自动移除开发者手动设置的 Content-Type 头，让浏览器自动处理。但在 PR #1826 之后的新版本中，库改为尊重开发者显式设置的请求头，不再自动移除。

这导致以下问题链：

1. 开发者手动设置了 Content-Type: multipart/form-data 头
2. 浏览器看到这个头已经存在，不再自动添加 boundary 参数
3. 服务器收到没有 boundary 参数的 multipart 请求，无法正确解析，返回错误

解决方案

正确的做法是：

1. 不要手动设置 Content-Type 头
2. 让浏览器自动处理 multipart 请求的格式化和头部设置

示例代码修正：

// 错误做法 - 手动设置 Content-Type
const { data, error } = await client.POST('/api/upload', {
  body: formData,
  headers: {
    'Content-Type': 'multipart/form-data' // 应该移除这行
  }
});

// 正确做法 - 让浏览器自动处理
const { data, error } = await client.POST('/api/upload', {
  body: formData
});

最佳实践

1. 对于文件上传等需要 FormData 的场景，建议使用专门的 bodySerializer 处理：

await client.POST('/api/upload', {
  body: file,
  bodySerializer: (body) => {
    const formData = new FormData();
    formData.append('file', body.file);
    return formData;
  }
});

2. 如果确实需要自定义 Content-Type，确保包含正确的 boundary 参数：

// 不推荐，除非有特殊需求
const boundary = '----WebKitFormBoundary' + Math.random().toString(16).substr(2);
await client.POST('/api/upload', {
  body: formData,
  headers: {
    'Content-Type': `multipart/form-data; boundary=${boundary}`
  }
});

总结

这个问题的本质是 HTTP 协议规范与库行为变更的交互问题。openapi-fetch 的新行为更符合"不隐藏魔法"的原则，让开发者对自己的请求有完全的控制权。理解 multipart/form-data 的工作原理和浏览器自动处理机制，可以帮助开发者避免这类问题。

对于文件上传等常见场景，最佳实践是信任浏览器和库的自动处理机制，避免手动设置可能干扰正常流程的头部信息。