まだAPIで消耗しているの?[Part2]

Part1の続きです

もしAPIがなんなのかまだわからない人は、前回のPart1に行くことをおすすめします👍


[Part2]でやること

今回は、APIを叩く際に非常に便利なツールを2つ紹介します。

まず、確認として、APIを叩く上で絶対に重要なことが、、、

①リクエストするURLを正確に作成する

②JSONに対応したモデルを作成する

→これを補うツールがあるのでそれを紹介します

●対象者:リクエストの書き方がまだわからない人、JSONに対応したモデルを作成することが出来ない人

●どんな言語でも問題ありません。


Restlet Client

Restlet Client: REST APIを簡易的にテストするツール

→ 簡単に言うと、URLをリクエストし、JSONを返すまでをテストしてくれます。

使用用途

①URLの書き方が正しいのか確かめたい時 → 合っていたらJSONが返ってくる。

②JSONの構造を知りたい時 → 使用する言語で分析するにはJSONの形を考慮しないといけないため

セットアップ

下記の記事を参考にして、クロームにRestlet Clientに取り込みましょう!!!


https://qiita.com/84zume/items/fac99705c39d2f18ada7



実際に使用していきます

今回は、YouTubeのAPIを使用していきたいと思います。

まずは、GoogleからYouTubeのapiKeyを取得してきましょう👍

(下記の記事を参考にしてください!)


https://www.d2c-smile.com/201611018039



①まずはプロジェクトを作成しましょう!

スクリーンショット 2019-04-18 14.51.52.png


②使用するURLを作成しましょう

YouTube Data API(v3)のSearch:listを参照し、URLを作成します。

●メイン

https://www.googleapis.com/youtube/v3/search

●まずは、apikeyを含ませます

https://www.googleapis.com/youtube/v3/search?key=あなたのapiKey

●次に必須の条件、partを含ませます。また、今回はネストされているプロパティをすべて取得するので、

スクリーンショット 2019-04-18 15.45.12.png

https://www.googleapis.com/youtube/v3/search?key=あなたのapiKey&part=snippet

●最後に検索する内容(q=)を含ませます,今回はHikakinで検索します

スクリーンショット 2019-04-18 22.55.16.png

→ https://www.googleapis.com/youtube/v3/search?key=あなたのapiKey&part=snippet&q=Hikakin

これでURLは完成です!!!!


③Restlet ClientでURLを叩く!

最後に作ったURLを赤で囲った所に入れます

スクリーンショット 2019-04-18 23.14.12.png

そして、sendボタンを押します!!!!!

→これがリクエストです!!

そうすると,JSONでレスポンスが返ってきます!

スクリーンショット 2019-04-19 1.35.37.png

これで、URLの正確性JSONの構造が把握できましたね!

ここで取得できた、JSONは次のツールで使用します!!


QuickType

QuickType: JSONデータから様々なプログラミング言語のモデルを自動生成してくれるツール

対応言語

C#

Go

C++

Java

TypeScript

Simple Types

Swift

Elm

Schema

使用用途

●JSONデータを自分の使用するプログラミング言語で認識できるモデルを作りたい時

セットアップ

こちらから→QuickType

登録不要&無料なので、すぐ利用でき、TRY NOWを押すだけです!!!!

スクリーンショット 2019-04-19 13.21.37.png


実際に使用していきます!


①使用するプログラミング言語を設定する!

スクリーンショット 2019-04-19 13.46.11.png


②Restlet Clientにて、レスポンスのJSONをQuickTypeに取り入れる

●まずは、先程作ったJSONを丸々コピーします!

スクリーンショット 2019-04-19 18.53.16.png

●コピーしたJSONを打ち込むと、、、モデルを自動生成してくれます!!!

スクリーンショット 2019-04-19 19.02.00.png

これにて無事終了です!!!


まとめ

では手順をおさらいします!!

①Restlet Clientで新規プロジェクトを準備します

②次に使いたいサービスのAPIを叩くために必要なURLを作成します

③Restlet ClientでURLを叩いてJSONを取得する

④QuickTypeで自分のプログラミング言語を設定する

⑤JSONより、モデルを作成する

以上です!!!!!!!!!!!!


予告:Part3[YouTube編]

※Part3はSwift限定です!!!

次回より、、、なんと、、、自分のアプリにAPIのデータを取り込んでいきます👍

取り込む際に使うのが、モデルなので全て繋がっているのです!!!!

●得られるモノ:YouTubeのAPIとSwiftを使用したアプリ作成の仕方

●使用する技術:Alamofire,Codable,Struct

SwiftでAPIを叩いたアプリの紹介例が殆どなかったので、参考になるかと思います!!!!!

乞うご期待、、、👍