Swift(Vapor) OpenAPI Generator处理Multipart PUT请求参数问题

你的需求完全可行，不需要必须单独枚举参数，问题核心在于OpenAPI定义的规范配置和生成代码后的逻辑处理。以下是具体解决步骤：

1. 修正OpenAPI定义的关键配置 #

确保你的openapi.json中，MyRequest对象与multipart/form-data的绑定符合规范，重点配置encoding字段明确表单字段到对象属性的映射：

{
  "openapi": "3.0.3",
  "paths": {
    "/saySomething": {
      "put": {
        "requestBody": {
          "$ref": "#/components/requestBodies/MyRequestMultipart"
        },
        "responses": {
          "200": {
            "description": "请求成功"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "MyRequest": {
        "type": "object",
        "properties": {
          "messageA": { "type": "string" },
          "messageB": { "type": "string" },
          "messageC": { "type": "string" }
        },
        "required": ["messageA", "messageB", "messageC"]
      }
    },
    "requestBodies": {
      "MyRequestMultipart": {
        "content": {
          "multipart/form-data": {
            "schema": { "$ref": "#/components/schemas/MyRequest" },
            "encoding": {
              "messageA": { "style": "form" },
              "messageB": { "style": "form" },
              "messageC": { "style": "form" }
            }
          }
        }
      }
    }
  }
}

encoding字段是核心，它告诉生成器如何将form-data中的每个字段映射到MyRequest的属性上。

2. 生成代码后的业务逻辑实现 #

重新运行代码生成器后，你可以直接从Input参数中提取映射好的MyRequest对象，无需手动转换：

struct MyAPIImpl: APIProtocol {
    func saySomething(input: Operations.SaySomething.Input) async throws -> Operations.SaySomething.Output {
        // 从input中获取已映射好的MyRequest实例
        guard let requestData = input.body?.myRequestMultipart else {
            throw Abort(.badRequest, reason: "缺少请求体")
        }
        
        // 直接访问对象属性
        let messageA = requestData.messageA
        let messageB = requestData.messageB
        let messageC = requestData.messageC
        
        // 编写你的业务逻辑
        print("收到消息：\(messageA)、\(messageB)、\(messageC)")
        
        return .ok(.init())
    }
}

3. 常见问题排查 #

• 如果生成的代码中找不到MyRequest相关的属性：检查OpenAPI定义中requestBody的content是否正确指向multipart/form-data，且schema是对象引用而非直接定义对象。
• 版本兼容问题：确保swift-openapi-generator和swift-openapi-vapor绑定的版本匹配，建议更新到最新兼容版本后，Clean Build Folder再重新构建。

总结 #

Swift OpenAPI Generator完全支持multipart/form-data请求体绑定到自定义对象，不需要单独枚举参数。只要OpenAPI定义中正确配置encoding映射，生成器会自动完成表单字段到对象属性的转换。

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