[Android-kotlin]APIを叩いて文字列とファイルをPOSTしたい

Question

###やりたいこと

お世話になります。Androidアプリ内でファイルを解析してくれるWEBサービスを利用したいです。

それにはapikeyと解析対象のファイルをサービスへPOSTする必要がありますので、その処理を実装したのですが、「apikeyの値がnullか空」という旨のエラーコードを返されてしまいます。これを解決したいです。

###APIの仕様書
こちらになります。今回はAPI version V2を利用するものとします。

###コードと問題点
retrofit2とOKhttpを使用しています。
まずはInterfaceから

#Myservice.kt

import okhttp3.RequestBody
import okhttp3.ResponseBody
import retrofit2.Call
import retrofit2.http.*
import okhttp3.MultipartBody
import retrofit2.Response
import retrofit2.http.POST

interface MyService{
    @Multipart
    @POST("v2/analyzeWav")
    fun postRawRequestForPosts(
        @Part file: MultipartBody.Part,
        @Part("testpart") requestBody : RequestBody
    ):Call<ResponseBody>
}

こちらはMainactivity.ktです。

#MainActivity.kt

package jp.co.casareal.retrofitbasic

import android.os.Bundle
import android.util.Log
import android.view.View
import android.widget.Toast
import androidx.appcompat.app.AppCompatActivity
import androidx.databinding.DataBindingUtil
import androidx.lifecycle.ViewModelProvider
import jp.co.casareal.retrofitbasic.databinding.ActivityMainBinding
import jp.co.casareal.retrofitbasic.util.Util
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.launch
import okhttp3.MediaType
import okhttp3.MultipartBody
import okhttp3.RequestBody
import retrofit2.Retrofit
import java.io.File

class MainActivity : AppCompatActivity() {

    // Retrofit本体
    private val retrofit = Retrofit.Builder().apply {
        baseUrl(" https://api.webempath.net/")
    }.build()

    // サービスクラスの実装オブジェクト取得
    private val service = retrofit.create(MyService::class.java)

    private val myViewModel: MyViewModel by lazy {
        ViewModelProvider.NewInstanceFactory().create(MyViewModel::class.java)
    }

    private val scope = CoroutineScope(Dispatchers.IO)

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        val binding =
            DataBindingUtil.setContentView<ActivityMainBinding>(this, R.layout.activity_main)

        binding.model = myViewModel
        binding.lifecycleOwner = this
    }

    /** POSTボタンが押された時の処理*/
    fun onPostButtonClick(view: View) {

        if (!myViewModel.author.value.isNullOrBlank() && !myViewModel.title.value.isNullOrBlank()) {

            //apikey送信設定
            val strContent = "{ 'apikey' : '自分のAPIキー'}"
            val mediaTypebody = MediaType.parse("application/json")
            val reqBodybody = RequestBody.create(mediaTypebody, strContent)

            //wavファイル送信設定
            val filepath = "解析対象のファイルのパス"
            val audioFile = File(filepath)
            val mediaTypefile = MediaType.parse("audio/*")
            val reqBodyfile = RequestBody.create(mediaTypefile, audioFile)
            val part = MultipartBody.Part.createFormData("part_name", audioFile.name, reqBodyfile)

            val post = service.postRawRequestForPosts(part,reqBodybody)

            scope.launch {
                val responseBody = post.execute()
                responseBody.body()?.let {
                    myViewModel.result.postValue(it.string())
                }
            }
        }
    }

※画面上にresponseを表示するという処理をさせているだけなのでレイアウトとviewmodelは省略します。

このコードを実行すると、{"error":1001,"msg":"apikey is null or empty"}と返されます。
curlで同じapikeyを送信すると1001エラーが出てこなかったためapikey自身には問題がなさそうで、
エラーコードからAPI仕様書を見ても同じような旨なのでapikeyがうまく送信されていないと思っています。

###知りたいこと、わからないこと
apikeyはMediaType.parse("application/json")でPOSTしていますが、こちらがいけないのでしょうか？

下記に並べている参考文献を含めPOSTで文字列を送る際はjsonで送るケースばかりで特別問題があるように思えませんが、エラー的にapikeyの送信に問題がありそうなので怪しいのかなと思っています。

よろしくおねがいします。

###追記
そもそもjson形式で送ってはいけないのでは？という指摘を頂いたので念の為仕様書にあったサンプルコードを追記します。（同時並行でmultipartでの文字列の取り扱いについても調べてまいります）

###参考にした文献
Let's はじめてのRetrofit for Android in Kotlin（サンプルコード付き）

retrofit multipart送信を行う

Answer 1

たぶんこれでいける、かも？

Myservice.kt

• requestBody のパート名は apikey にする

     fun postRawRequestForPosts(
         @Part file: MultipartBody.Part,
-        @Part("testpart") requestBody : RequestBody
+        @Part("apikey") requestBody: RequestBody
     ):Call<ResponseBody>

MainActivity.kt

• reqBodybody の中身は API キーそのまま、mime type は plain text
• part のパート名は wav にして、mime type も wav にする

             //apikey送信設定
-            val strContent = "{ 'apikey' : '自分のAPIキー'}"
-            val mediaTypebody = MediaType.parse("application/json")
+            val strContent = "自分のAPIキー"
+            val mediaTypebody = MediaType.parse("text/plain")
             val reqBodybody = RequestBody.create(mediaTypebody, strContent)
 
             //wavファイル送信設定
             val filepath = "解析対象のファイルのパス"
             val audioFile = File(filepath)
-            val mediaTypefile = MediaType.parse("audio/*")
+            val mediaTypefile = MediaType.parse("audio/wav")
             val reqBodyfile = RequestBody.create(mediaTypefile, audioFile)
-            val part = MultipartBody.Part.createFormData("part_name", audioFile.name, reqBodyfile)
+            val part = MultipartBody.Part.createFormData("wav", audioFile.name, reqBodyfile)
 
             val post = service.postRawRequestForPosts(part, reqBodybody)

Comments

[退会済みユーザー]

うまくいきました...!ありがとうございます...!

今回うまく行かなかったのはKAOsaka様がおっしゃっていたようにmutlipartなのでそもそもjsonで送ってはNGだったこと、interfaceの@PARTのstring部とMultipartBody.Part.createFormDataの第一引数が項目として送られるからそこを直してうまくいった、という認識であってますか？

[hoshi-takanori]

実は webempath のサイトに node.js のコードがあったので、同じ形式で送られるようにしてみました。今回の場合、multipart の各パートの名前を合わせることと、api キーをそのまま送ることがポイントだと思います。

[退会済みユーザー]

原因や試したことも記述してくださりありがとうございました。目的が果たされたのでBAといたします。

Answer 2

こちらのキーと値を囲っているシングルクオートをダブルクオートにしてもダメでしょうか？

val strContent = "{ 'apikey' : '自分のAPIキー'}"

追記

Unexpected token (use ' ; ' to separate expressions on the same line
エラーが出ると同時にapikeyと中身両方共 Unresolved refference出ちゃいます...

多分こうしちゃってると思いますので

val strContent = "{ "apikey" : "自分のAPIキー"}"

こうしてください。

val strContent = "{ \"apikey\" : \"自分のAPIキー\" }"

Comments

[退会済みユーザー]

Unexpected token (use ' ; ' to separate expressions on the same line
エラーが出ると同時にapikeyと中身両方共 Unresolved refference出ちゃいます...

[KAOsaka]

回答追記しましたのでご確認ください。

[退会済みユーザー]

追記ありがとうございます、書いてあったとおりにやってしまっていたので新しく試してみましたが1001エラーのままでした...

[KAOsaka]

そうですか、、、ちなみにAPI Keyにバックスラッシュとか入ってたりしないですか？

[退会済みユーザー]

apikeyは小文字と大文字のローマ字と数字のみで構成されてます...

[KAOsaka]

今気づいたんですがAPI仕様的にはContent-Type: multipart/form-dataなのでJSON形式でAPIKeyを使用してるのがおかしいのかもしれませんね。

[退会済みユーザー]

なるほど、その場合だと
MediaType.parse("application/json")
より
MediaType.parse("plain/text")
のほうが適切という感じなんでしょうか？ ちょっと、念の為API仕様書のサンプルコード(curl,java)も追記します

[KAOsaka]

この部分はHTTPリクエストのContent-Dispositionに当たると思うので、multipart/form-dataかと思いますが、ちょっと自信ないのでplain/textでダメならmultipart/form-dataも試してみてください。https://developer.mozilla.org/ja/docs/Web/HTTP/Headers/Content-Disposition#as_a_header_for_a_multipart_body