Swift OpenAPI生成器实现文件上传POST请求的疑问

1. OpenAPI Schema字段调整 #

你当前Schema里fileName字段设置type:string+format:binary是错误的——format:binary是用来标记二进制数据的，文件名属于纯字符串类型。正确的调整方案：

• 保留fileName字段，设置为type:string，移除format:binary，专门用来传递文件名
• 新增file字段，设置type:string+format:binary，用于存储文件的二进制数据
• 确保请求的content类型为multipart/form-data，并在schema中定义这两个字段作为表单分块

示例Schema片段：

paths:
  /telemetry/upload:
    post:
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                fileName:
                  type: string
                file:
                  type: string
                  format: binary
            encoding:
              file:
                contentType: text/csv

2. Swift代码中传入文件名 #

Swift OpenAPI生成器会根据你的Schema生成对应的请求结构体，不能直接用.binary(fileData)的方式传递。你需要构造multipart类型的请求体，同时传入文件名和文件数据：

假设生成的请求结构体为UploadRideRequest，对应的请求体是UploadRideRequestBody，代码示例如下：

// 构造multipart请求体
let requestBody = UploadRideRequestBody.multipart(
    .init(
        fileName: "your_ride_data.csv",
        file: fileData
    )
)
// 发起请求
let response = try await client.uploadRide(.init(body: requestBody))

如果生成代码的multipart部分是通过MultipartFormField数组构造，写法如下：

let formFields: [MultipartFormField] = [
    .init(name: "fileName", value: "your_ride_data.csv"),
    .init(name: "file", value: fileData, contentType: "text/csv")
]
let requestBody = UploadRideRequestBody.multipart(.init(fields: formFields))
let response = try await client.uploadRide(.init(body: requestBody))

具体写法以生成代码的实际结构为准，你可以查看UploadRideRequestBody的定义，里面会有明确的构造逻辑注释。

3. 更多Swift OpenAPI生成器的参考资源 #

• 查看Swift OpenAPI Generator GitHub仓库的Wiki和Release Notes，里面包含很多官方基础示例未覆盖的细节和进阶用法
• 研究生成代码的注释：生成的每个结构体、方法都会附带与你的OpenAPI Schema对应的详细注释，是最贴合你场景的参考文档
• 在GitHub上搜索关键词Swift OpenAPI Generator multipart，能找到大量开发者分享的实际文件上传案例
• 浏览Swift Forums的OpenAPI Generator板块，里面有不少开发者交流的问题和解决方案

内容的提问来源于stack exchange，提问作者Nissaba