KotlinのAPI通信でPOSTリクエストを送る方法!初心者向け徹底ガイド
生徒
「この前GETリクエストでデータを取得する方法を学びましたけど、逆に自分からデータを送るにはどうすればいいんですか?」
先生
「それにはPOSTリクエストという方法を使います。APIに対してデータを送る通信方法です。たとえば、フォームに入力した内容をサーバーに送るときなどに使われますよ。」
生徒
「GETとの違いや、Kotlinでどう書くのか詳しく教えてください!」
先生
「もちろん!今回は初心者でも使いやすいOkHttpライブラリを使って、KotlinでPOSTリクエストを送る方法をしっかり解説していきましょう!」
1. POSTリクエストとは?
POSTリクエストとは、インターネット上のサーバーにデータを送信する通信方法のことです。たとえば、ユーザーが会員登録フォームに入力した名前やメールアドレスを送るときなどに使います。
GETは「情報を取りに行く」、POSTは「情報を送る」という役割の違いがあります。
2. KotlinでPOST通信を行うには?
KotlinでPOST通信を行うには、OkHttpという通信ライブラリを使うと便利です。前回と同じく、まずはbuild.gradle.ktsに以下のコードを追加します。
dependencies {
implementation("com.squareup.okhttp3:okhttp:4.12.0")
}
これで準備は完了です。
3. KotlinでPOSTリクエストを送る基本の書き方
では実際に、JSON形式のデータをサーバーに送るPOSTリクエストの基本コードを見てみましょう。
import okhttp3.MediaType.Companion.toMediaType
import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.RequestBody.Companion.toRequestBody
fun main() {
val client = OkHttpClient()
val json = """{"name":"Taro","age":25}"""
val mediaType = "application/json; charset=utf-8".toMediaType()
val requestBody = json.toRequestBody(mediaType)
val request = Request.Builder()
.url("https://jsonplaceholder.typicode.com/posts")
.post(requestBody)
.build()
val response = client.newCall(request).execute()
println(response.body?.string())
}
このコードでは、JSONデータをtoRequestBodyでリクエストボディに変換し、それをpost()メソッドに渡しています。
4. JSON形式とは?
JSON(ジェイソン)形式は、データを文字で表現する方法のひとつです。POSTリクエストでは、このJSON形式でデータを送るのが一般的です。
たとえば:
{"name":"Taro","age":25}
このように、名前と年齢をペアで表現しています。
5. 通信エラーの対処も忘れずに
POSTリクエストも、GETと同様に通信エラーが起こる可能性があります。エラー対策として、例外処理(try-catch)を使うのが大切です。
try {
val response = client.newCall(request).execute()
if (response.isSuccessful) {
println(response.body?.string())
} else {
println("エラーコード: ${response.code}")
}
} catch (e: Exception) {
println("通信に失敗しました: ${e.message}")
}
こうすることで、万が一通信がうまくいかなかったときでも、アプリが止まらずに安心です。
6. 送信先APIの例:テスト用API
今回はhttps://jsonplaceholder.typicode.com/postsというテスト用APIを使用しています。これは、実際に通信してもデータが保存されない安心なサービスで、学習用に最適です。
本番のAPIを使うときは、送信するデータの形式や内容、認証の方法などをAPI提供元のドキュメントに従って設定しましょう。
7. Kotlinでフォームのようにデータを送る
JSONではなく、Webのフォームと同じ形式でデータを送りたいときはFormBodyを使います。
import okhttp3.FormBody
val formBody = FormBody.Builder()
.add("username", "taro")
.add("password", "pass1234")
.build()
val request = Request.Builder()
.url("https://example.com/login")
.post(formBody)
.build()
この方法は、ログイン画面などでよく使われます。
8. KotlinでAPI連携する際の注意点
POSTリクエストでAPIと連携するときは、以下の点に注意しましょう。
- 送信するデータの形式(JSONやフォーム)を確認する
- サーバーが何を受け取る仕様なのかを理解する
- エラー処理を必ず書く
これらを守れば、初心者でも安心してKotlinでAPI通信が行えるようになります。