【Swift】Moyaを使ってAPI通信をしてみた
2022.03.23
はじめに
今回はAPI通信のコードを簡単にカプセル化できるライブラリMoyaを使ってAPI通信をしてみます。
SwiftでAPI通信のライブラリといえばAlamofireをよく聞くと思うんですが、MoyaはそのAlamofireを使用してAPI通信を行うライブラリです。
MoyaがAlamofireを使用しているため、Alamofireのことも知っておかなければダメかと思ったんですが、そのようなことはなく簡単にAPI通信を実装することができました。
本記事では、OpenWeatherMapのAPIで天気情報を取得して画面に表示するところまで実装しています。
本記事がMoyaを使用する方のお役に立てば幸いです。
Moyaについて
MoyaはAlamofireを使用してAPI通信を行うライブラリです。
Alamofireを直接呼び出すことを十分にカプセル化して、API通信の実装をすることができます。
Moyaの特徴
- Swiftのコンパイラを使用して、正しいAPIエンドポイントアクセスのチェックをする
- Enum型を使用して、エンドポイントを明確に定義する
- テストスタブの作成が容易なため、ユニットテストが簡単に書ける
図1 Moyaを使用した時のレイヤーイメージ（MoyaのReadme.mdから引用）
APIの準備
Moyaで叩くAPIの準備をしていきます。
今回私が使用するAPIはOpenWeatherMapのAPIです。
さっそくですが、OpenWeatherMapのAPIの準備をしていきます。
まず、OpenWeatherMapのサイトに移動し、アカウントを作成します。
APIを叩く際にはパラメータとしてAPIkeyが必要になりますので、アカウント作成後にアカウントページのAPIkeysのタブを選択しAPIkeyを確認しておいてください。
OpenWeatherMapのAPIには数多くの種類がありますが、今回はCurrentWeatherDataというAPIを使用していきます。
CurrentWeatherDataは緯度・経度で指定された場所の天気を取得できるAPIです。
緯度・経度を指定するといっても、難しいのでジオコーティングAPIという都市名を緯度・経度に変換してくれるAPIを使用します。
実際に使用するAPI
api.openweathermap.org/data/2.5/weather?q={city name}&appid={API key}&units=metric&lang=ja
| パラメータ | 要否 | 概要 |
| q | 必須 | 市名、州コード、国コードをカンマで割ったもの |
| appid | 必須 | 取得したAPIkey |
| mode | オプション | 応答形式。xmlとhtmlに変更可能でデフォルトではjson |
| units | オプション | 温度を華氏、摂氏、ケルビン単位で指定できる |
| lang | オプション | 言語指定 |
今回は摂氏での温度を取得したいため「units=metric」、
言語は日本語で取得したいため「lang=ja」にパラメータを設定しています。
Moyaの導入
APIの準備ができたので、次は実際にMoyaをプロジェクトに導入していきたいと思います。
Moyaの導入方法はいくつかありますが、今回はCocoaPodsを使用してMoyaを導入していきます。
CocoaPodsでの導入手順
- ターミナルを起動して、Moyaを導入するプロジェクトに移動
- pod init で Podfile を作成
- Podfile に pod 'Moya', '~> 15.0' を追加
- pod install でMoyaを導入
$ cd {プロジェクトのディレクトリ} # Moyaを導入するプロジェクトに移動
$ pod init # Podfile を作成
# Podfile に pod 'Moya', '~> 15.0' を追加
$ pod install # Moyaを導入
pod install でインストールが完了し、.xcworkspaceが作成されたらOKです。
レスポンスデータのModelを実装
APIを叩いた際のレスポンスデータはjsonなので、デコードするためのModelを実装していきます。
まずはレスポンスデータがどのようになっているか確認するためPostmanを使用してレスポンスデータを確認します。
実際にPostmanを使用して確認したレスポンスデータは以下の通りです。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 | { "coord": { "lon": 135.5022, "lat": 34.6937 }, "weather": [ { "id": 800, "main": "Clear", "description": "晴天", "icon": "01n" } ], "base": "stations", "main": { "temp": 11.67, "feels_like": 10.09, "temp_min": 9.7, "temp_max": 11.92, "pressure": 1015, "humidity": 46, "sea_level": 1015, "grnd_level": 1013 }, "visibility": 10000, "wind": { "speed": 3.01, "deg": 43, "gust": 3.9 }, "clouds": { "all": 0 }, "dt": 1647351576, "sys": { "type": 2, "id": 20513, "country": "JP", "sunrise": 1647292168, "sunset": 1647335087 }, "timezone": 32400, "id": 1853909, "name": "大阪市", "cod": 200 } |
レスポンスデータが確認できたので、Modelを実装していきたいと思います。
全てのレスポンスデータを使用するわけではないので、使用するデータの分だけModelを実装していきます。
今回は以下のようにWeatherDataというModelを実装しました。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | import Foundation struct WeatherData: Decodable { let weather: [Weather] let main: Main let name: String } struct Weather: Decodable { let description: String let icon: String } struct Main: Decodable { let temp: Double let tempMin: Double let tempMax: Double let pressure: Double let humidity: Double } |
ポイントとしては、jsonからWeatherDataにデコードする必要があるためDecodableプロトコルに準拠していることです。
Moyaを使用してAPI通信を実装
次にMoyaを使用してAPI通信を実装していきたいと思います。
APIターゲットを設定
まずはenumでMyServiceを作成し、使用するAPIを列挙していきます。
今回は天気情報を取得するAPIを使用するので、enumに case getWeather(city:String) を追加しました。
enumに使用するAPIを列挙することができたら、extensionでMyServiceをTargetTypeプロトコルに準拠させてリクエストの詳細を設定していきます。
実際に実装したものが以下になります。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 | import Foundation import Moya enum MyService { case getWeather(city: String) } extension MyService: TargetType { var baseURL: URL { URL(string: "https://api.openweathermap.org/data/2.5")! } var path: String { switch self { case .getWeather: return "/weather" } } var method: Moya.Method { switch self { case .getWeather: return .get } } var task: Task { switch self { case .getWeather(let city): let appId = "{発行したアカウントのAPIkey}" let unit = "metric" let lang = "ja" return .requestParameters(parameters: ["q": city, "appid": appId, "units": unit, "lang": lang], encoding: URLEncoding.queryString) } } var headers: [String : String]? { return ["Content-type": "application/json"] } } |
var baseURL: URL
APIのベースとなるURLを設定します。
var path: String
ベースURLに続くpathをStringで設定します。
var method: Moya.Method
HTTPメソッドを設定します。
今回はGETメソッドでAPIを叩くため.getをreturnしています。
var task: Task
リクエストする時のDataやパラメータを設定します。
今回はURLでパラメータを送信するため、.requestParameters(parameters: ["q": city, "appid": appId, "units": unit, "lang": lang], encoding: URLEncoding.queryString)をreturnしています。
var headers: [String : String]?
HTTPヘッダを設定します。
今回はリクエストの本文の形式がjsonのため、["Content-type": "application/json"]をreturnしています。
Moyaでリクエストする
APIターゲットの設定ができたので、次にリクエストを実行するコードを書いていきます。
今回はリポジトリパターンを意識して、WeatherRepositoryクラスを作成しました。
Moyaを使用してリクエストする方法ですが、まずMoyaProviderを生成します。そして生成したMoyaProviderのrequestメソッドでリクエストを送り、クロージャーで結果を受け取ります。
実際に実装したものが以下になります。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 | import Foundation import Moya typealias CompletionHandler<T> = (Result<T,MoyaError>) -> Void final class WeatherRepository { private let provider = MoyaProvider<MyService>(plugins: [NetworkLoggerPlugin()]) func getWeathreData(city: String, completion: @escaping CompletionHandler<WeatherData>) { provider.request(.getWeather(city: city)) { [weak self] result in guard let self = self else { return } switch result { case let .success(response): completion(self.decodeResponseToWeatherData(response: response)) case let .failure(moyaError): completion(.failure(moyaError)) } } } private func decodeResponseToWeatherData(response: Response) -> Result<WeatherData, MoyaError> { do { let decoder = JSONDecoder() decoder.keyDecodingStrategy = .convertFromSnakeCase let response = try response.filterSuccessfulStatusAndRedirectCodes() let weatherData = try response.map(WeatherData.self, using: decoder) return .success(weatherData) } catch let error { let moyaError = error as! MoyaError return .failure(moyaError) } } } |
実装について簡単に説明します。
まず定数providerでMoyaProviderを生成して保持します。MoyaProviderは作成したMyServiceを指定して、さらにオプションでNetworkLoggerPlugin()を指定しています。NetworkLoggerPluginはリクエストの内容をログに表示するプラグインです。他にもプラグインが用意されているので、気になる方は調べてみてください。
次にgetWeathreDataメソッドです。このメソッドではproviderのrequestメソッドでリクエストをしています。そして、リクエストの結果をcompletionで返すようにしています。
最後にdecodeResponseToWeatherDataメソッドです。このメソッドはレスポンスを引数として受け取って、WeatherDataに変換できた場合はWeatherDataを返して、変換できなかった場合はMoyaErrorを返します。
UIに取得した天気情報を表示
UIを作成
レスポンスをUIに表示するため、storyboardでUIを作成していきます。
天気情報を表示するためのラベルとイメージビュー、都市を入力するためのテキストフィールドとボタンを配置します。
実際に作成したstoryboardが以下です。
UIViewControllerを実装
storyboardでUIを作成することができたので、次はUIViewControllerを作成していきます。
先ほど作成したstoryboardとWeatherViewControllerを紐づけて、ボタンが押された時にテキストフィールドに入力されている都市名でリクエストを送り、その後レスポンスデータを画面に表示するように実装しました。
実際に実装したものが以下になります。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 | import UIKit final class WeatherViewController: UIViewController { @IBOutlet private weak var cityLabel: UILabel! @IBOutlet private weak var weatherImageView: UIImageView! @IBOutlet private weak var weatherLabel: UILabel! @IBOutlet private weak var tempMaxLabel: UILabel! @IBOutlet private weak var tempMinlabel: UILabel! @IBOutlet private weak var tempLabel: UILabel! @IBOutlet private weak var humidtyLabel: UILabel! @IBOutlet private weak var pressureLabel: UILabel! @IBOutlet private weak var cityTextField: UITextField! private let weatherRepository = WeatherRepository() @IBAction private func didTapEnterButton(_ sender: Any) { getWeatherData(city: cityTextField.text!) } private func getWeatherData(city: String) { weatherRepository.getWeathreData(city: city) { [weak self] result in guard let self = self else { return } switch result { case .success(let weatherData): self.showWeatherData(weatherData: weatherData) case .failure(let moyaError): print(moyaError.localizedDescription) } } } private func showWeatherData(weatherData: WeatherData) { cityLabel.text = weatherData.name weatherImageView.image = UIImage(named: weatherData.weather.last!.icon) weatherLabel.text = weatherData.weather.last!.description tempMaxLabel.text = "\(weatherData.main.tempMax)" tempMinlabel.text = "\(weatherData.main.tempMin)" tempLabel.text = "\(weatherData.main.temp)" humidtyLabel.text = "\(weatherData.main.humidity)" pressureLabel.text = "\(weatherData.main.pressure)" } } |
以上で実装の方は終わりになります。
シミュレータを起動して、テキストフィールドにTokyoと入力後、ボタンを押すと天気情報が表示されることを確認できると思います。
天気の画像はOpenWeatherのサイトにありますので、同じものを表示させる場合はこちらからダウンロードしてください。
さいごに
今回、簡単ではありますがMoyaを使用して天気APIを叩き、実際に画面に表示するところまで実装してみました。
本記事がMoyaを使用する方のお役に立てば幸いです。
ご覧いただき、ありがとうございました。
書いた人はこんな人
- 業務ではiOS開発に携わらせていただいています。
まだまだ分からないことだらけで、日々分からないことと戦いながら仕事をしている者です。
ブログ記事は暖かい目で見ていただけるとありがたいです。
関連記事
採用情報
\ あの有名サービスに参画!? /
バックエンドエンジニア
\ クリエイティブの最前線 /
フロントエンドエンジニア
\ 世界を変える…！ /
Androidエンジニア
\ みんなが使うアプリを創る /
iOSエンジニア
