AndroidでREST APIを取り扱うお話

  • このエントリーをはてなブックマークに追加

前回のお話でREST APIを気軽に確認する内容を書きましたが、今回は実際にスマホアプリ内でREST APIのやりとりを行う方法をまとめます。

以前はOkHttpというライブラリを使うことが多く、現在もそれが主流になりますが、今回はkotlinで使えるRetrofitと呼ばれるライブラリを使っていきましょう

インストール

通信するので当然アプリ側にインターネット接続の設定をする必要があります。

/app/build.gradleにRetrofitを書きましょう。
JSONでやりとりするのでGsonも入れましょう。

バージョンは2022.08時点ですが、多分3年くらい変わってない気がします…

これで簡単にsyncを押すと利用可能です。

使い方

使い方と言ってもREST APIの基本的な設定(メソッドやヘッダーなど)をInterface、データの構造をクラス化して、各画面で呼び出す感じとなります。
名前は何でもいいですが、こんな感じで各ファイルにまとめたいと思います。

Interface ApiService.kt
Model ApiModel.kt
Fragment MainFragment.kt

GETの場合

例として架空のREST APIを用意します。

内容 メンバー情報取得
詳細 メンバー情報を取得する
URI /gray/
METHOD GET
認証 Authorization: Bearer ais7Uki8d300ibGhQOee51die
パラメータ No parameters
レスポンス


こんな感じです。

認証用のトークンをheaderに設定して、GETで叩くとメンバー情報を取得できるという感じですね。

まずはデータクラスをまとめましょう。
今回はレスポンスの値を渡すので、ApiModel.ktに以下のように定義します。

[members]は複数の配列で来るので、Membersの配列として定義します。

定義ができたところで、Interfaceに書いちゃいましょう。

@Headersには今回UserAgentを設定してます。
@GETや@POSTや@PUT、@DELETEもあるので簡単にメソッドを設定できますね。

getMembers関数を定義してます。
引数は認証用のtokenを渡すことでHeaderに記載されます。
戻り値は先ほど定義した[ResponseMembers]ですね。

これで設定完了です。

実際に呼び出す場合は

簡単な実装ですが、これで簡単に取得できます。
シンプルで簡単にできますよね。
ただ、TextViewに反映しようとするとメインスレッドでないと怒られるのでそこだけ注意してください

POSTの場合

POSTの場合も実は簡単です。

内容 メンバー情報新規登録
詳細 メンバー情報を新規登録する
URI /gray/
METHOD POST
認証 Authorization: Bearer ais7Uki8d300ibGhQOee51die
パラメータ

レスポンス


モデルクラスを設定しましょう

インターフェースです

取得時とあまり変わりません。変わった点はメソッドがPOSTになったのと、@Bodyでデータクラスを渡すところですね。

それでは実装しましょう。

GETとの違いは引き渡す値をまとめて引数に渡してますね。
これだけで簡単にPOST通信することが可能です。

PUT通信の場合

PUTは主に更新系で使うメソッドですが、この場合もPOSTとよく似た形です。

内容 メンバー情報の変更
詳細 メンバー情報を変更する
URI /gray/{id}
METHOD PUT
認証 Authorization: Bearer ais7Uki8d300ibGhQOee51die
パラメータ

レスポンス


変更するIDをURIにつけてPUTします。 例) /gray/1

データクラスは既存のものを流用できるのでInterfaceを作ります。

putMember関数の第二引数に変更するIDを渡します。

実装は以下のようになります。

これでPUTが行えます。

今回は取り上げませんがDELETEも同様な感じで実装が可能です。

まとめ

油断すると新しいトレンドがどんどん出てくるスマホアプリ開発ですが、Retrofitを使うと、わかりやすく実装できるので、非常に楽ですね。

次はSwiftでもREST APIの使い方の紹介ができればいいかなと思います。

個人的にはViewModelを使っていきたいのでそっちを勉強がてら投稿するかもしれませんが…

 

執筆者:松本[ エンジニア ]

関連記事

Webサイト制作

Webアクセシビリティの基本を学ぼう!

近年Webサイト制作時に求められる『Webアクセシビリティ』。 正直なんだかよくわからない、ややこしそうだなあと思う方も多いと思います。 自分も勉強中ではありますが、今回は対応しやすそうな内容をなるべくわかりやすくまとめてみました。 一緒にWebアクセシビリティについて学んでいきましょう。 目次1 そもそもWebアクセシビリティってなに?2 基本的な対応内容2.1 色のコントラストをはっきりさせよう2.2 文字サイズを変更できるようにしよう2.3 できるだけテキストベースを心 […]

プログラミング

【PHP】ソーシャルログインに対応したお話(LINEログイン編) ②

前回はLINE Developersでチャネル登録までを行いました。 今回は実際にPHPでログインを実装していきます。 目次1 初期設定を定数にする2 LINE ログインのURLを作成する3 コールバック時の処理4 最後に 初期設定を定数にする 最初にdefineでチャネル登録した情報やAPIのURLを定義します。 メールアドレスを取得したい場合はLINE_SCOPEに「email」を追記してください。 LINE ログインのURLを作成する LINEログインに利用するログイン […]

Webサービス

【PHP】ソーシャルログインに対応したお話(LINEログイン編) ①

今回はLINEログインです。 LINEログインは他のソーシャルログインと違って、電話番号必須なので、ユーザーがアカウントを無限に発行するということがなく、しかもOSに関係なくアカウントを使用できるので、特にB2Cサービスを考える場合には是非導入を進めたいと思います。 逆に法人サービスで使う場合、法人担当者が個人のLINEアカウントを使用することはないと思うので、あくまで個人向けサービスがよいかなと思います。 LINEログインについての概要はこちらに詳しく書いています。 htt […]

株式会社8bit (エイトビット)

東京都目黒区でWebサイト制作、Webシステム開発などを行っております。
コーポレートサイトやWebサービスの企画・提案を得意としており、自社での経験を元にアイデアをカタチにするお手伝いをさせていただいております。

Web制作に関するご相談はお気軽にどうぞ

弊社に制作をご依頼いただく際の費用感をご確認いただける、
見積りシミュレーションをご用意いたしました。