SwiftでAPIKitを使用し画像データをPOSTしたい。

Question

###前提・実現したいこと
SwiftでAPIKitを使用し画像データをPOSTしたいのです。
サーバーサイドはPHPで書いています。

###発生している問題・エラーメッセージ

画像データがなければparametersに入れてPOSTできるのですが、画像データを入れるとPOSTできなくなります。

###該当のソースコード

// [POST] /api/users
    struct PostUser: APIRequest {
        typealias Response = User
        
        var authenticate: Bool { return false }
        var method: HTTPMethod = .post
        var path: String { return "/api/users" }
        var imageData: Data?

        var bodyParameters: BodyParameters? {
            let part = MultipartFormDataBodyParameters.Part(data: imageData!, name: "thumbnail")
            return MultipartFormDataBodyParameters(parts: [part])
        }
        
        var parameters: Any? {
            return [
                    "screen_name": "dasfasfaa",
                    "name": "fsfdsfda",
                    "password": "daffffffffs",
                    "email": "[e-mail]"]
        }
        
        init(imageData: Data) {
            self.imageData = imageData
        }
        
        func response(from object: Any, urlResponse: HTTPURLResponse) throws -> User {
            return try decodeValue(object)
        }
        
        func intercept(object: Any, urlResponse: HTTPURLResponse) throws -> Any {
            print(urlResponse.statusCode)
            print(urlResponse)
            print(object)
            return object
        }
    }

###試したことと疑問な事
1,parametersにimageDataも入れてみた。

        var parameters: Any? {
            return [
                    "thumbnail": imageData!,
                    "screen_name": "dasfasfaa",
                    "name": "fsfdsfda",
                    "password": "daffffffffs",
                    "email": "[e-mail]"]
        }

"thumbnail": imageData!を削除してみるとinterceptメソッド内のobjectの中でthumbnail field is requiredとなりますが、
上記のように"thumbnail": imageData!を追加するとinterceptメソッドも実行されずswitch文の.failureに入りAPIKit.SessionTaskError error 1となります。

2,imageDataがなければPOSTできるのか試してみた。
(サーバー側の仕様でthumnailがrequiredなので成功はしていませんがinterceptメソッドの中のobjectではthumbnail field is requiredになります。)

3,そもそもPHP側ではfileで受け取ると仕様書に書いてありますが、Data型にして送るのはあっているのか。
ターミナルで

curl -XPOST -H "Accept: application/json" 
-F thumbnail=@/Users/名前/Desktop/test.png 
-F screen_name=hoge 
-F name=fuga
-F password=hogefuga 
-F email=[e-mail] 
https://任意のURL

するとPOSTは成功します。

4,APIKitではAcceptのデフォルト値はapplication/jsonなのか。
現在は特に指定などはしていません。

###知りたいこと
APIKitで画像データをPOSTするときのAPIの記述のサンプルなど知りたいです。
どうかよろしくお願いします。

Answer 1

    // [POST] /api/users
    struct PostUser: APIRequest {
        typealias Response = User

        var authenticate: Bool { return false }
        var method: HTTPMethod = .post
        var path: String { return "/api/users" }
        var imageData: Data?
        var screenName: String?
        var name: String?
        var password: String?
        var email: String?

        var bodyParameters: BodyParameters? {
            var params = [
                try! MultipartFormDataBodyParameters.Part(value: screenName!, name: "screen_name"),
                try! MultipartFormDataBodyParameters.Part(value: name!, name: "name"),
                try! MultipartFormDataBodyParameters.Part(value: password!, name: "password"),
                try! MultipartFormDataBodyParameters.Part(value: email!, name: "email")
            ]
            if let imageData = imageData {
                params.append(MultipartFormDataBodyParameters.Part(data: imageData, name: "thumbnail", mimeType: "image/jpeg", fileName: "thumbnail"))
                return MultipartFormDataBodyParameters(parts: params)
            } else {
                return MultipartFormDataBodyParameters(parts: params)
            }
        }

        init(imageData: Data?, screenName: String?, name: String?, password: String?, email: String?) {
            self.imageData = imageData
            self.screenName = screenName
            self.name = name
            self.password = password
            self.email = email
        }

        func response(from object: Any, urlResponse: HTTPURLResponse) throws -> User {
            return try decodeValue(object, rootKeyPath: "user")
        }

        func intercept(object: Any, urlResponse: HTTPURLResponse) throws -> Any {
            return object
        }
    }

現状このようなコードで正常に動いています。

Answer 2

APIKitを使って試してないので不確かですが、
multipart/form-data と application/x-www-form-urlencoded 、
あるいは application/json を同時に使うことはできないので
var parameters ... を抜きにして、
かわりに bodyParameters の return に parametersの配列を追加してみてはいかがでしょうか。

let part = MultipartFormDataBodyParameters.Part(data: imageData!, name: "thumbnail")
return MultipartFormDataBodyParameters(parts: [part])

↓

let part = MultipartFormDataBodyParameters.Part(data: imageData!, name: "thumbnail")
let part2 = MultipartFormDataBodyParameters.Part(value: "hoge", name: "screen_name")
//...
return MultipartFormDataBodyParameters(parts: [part, part2, part3, ...])

parametersについては、APIKit自身のソース中に
The convenience property for queryParameters and bodyParameters
という記述があることから、一緒に使うものではなさそうです。

// https://github.com/ishkawa/APIKit/blob/master/Sources/APIKit/Request.swift:77

 public var bodyParameters: BodyParameters? {
        guard let parameters = parameters, !method.prefersQueryParameters else {
            return nil
        }

        return JSONBodyParameters(JSONObject: parameters)
}

82行目で上書きされるようです。

Comments

[bearcanyon]

回答ありがとうございました！