こんにちわlisです！
WebAPIにリクエストするには、対象のURLが必要ですよね。
今回はQiita APIを例に、GETリクエストするためのURLを調べる流れを書いてみました！
Qiita APIの場合
まずQiitaの場合、ここにAPIについてのドキュメントが公開されています。
今回は例として、ユーザ一覧を取得するとします。
リクエストするURL
ドキュメントの説明を見てみます。
リクエスト
APIとの全ての通信にはHTTPSプロトコルを利用します。アクセス先のホストには、Qiitaのデータを利用する場合には qiita.com を利用し、Qiita Teamのデータを利用する場合には .qiita.com を利用します (には所属しているTeamのIDが入ります)。
どうやらQiitaとQiita Teamとで、対象のURLが異なるようです。
今回はQiitaのデータなので「qiita.com」でOKですね。
ユーザ一覧を取得するための情報を得る
次にユーザ一覧を取得したいので「ユーザ」の欄を調べていきます。
見てみると取得したパラメータの説明が書いてありますね。
ベースとなるURLを作る
この「ユーザ」の欄を見ていくと
全てのユーザの一覧を作成日時の降順で取得します。
という説明の項目にたどり着きます。
GET /api/v2/users
全てのユーザの一覧を作成日時の降順で取得します。
ココに書かれた「/api/v2/users」という箇所が使用するURLのキーとなります。
QiitaのURLである「https://qiita.com」に、今回の「/api/v2/users」をくっつけることで、ベースとなるURLが作成できます。
https://qiita.com/api/v2/users
URLにパラメータをくっつける
「GET /api/v2/users」の項目を見ていると、
- page
- per_page
先程作った「https://qiita.com/api/v2/users」に、pageとper_pageという2つのパラメータをくっつけていきます。
GET /api/v2/users?page=1&per_page=20 HTTP/1.1
という記述があるように
https://qiita.com/api/v2/users?page=1&per_page=20
のようにつければOKです。
設定できる値については、各パラメータ説明に書かれていますね。
今回作成したURLの場合、ユーザ一覧を1ページ～20ページまでの分、取得する事ができます。
URLが正しいか簡単に調べる方法
作成したURLを、ブラウザでアクセスしてみましょう。
正しければ、結果がズラーっと表示されます。
正しくない場合
{"message":"Not found","type":"not_found"}
などのようにNGの結果が返ってきます。
今回のNGは「https://qiita.com/api/v2/usears」にアクセスしてみました。
ちなみにパラメータを不正にしてみたところ、普通にGETできてしまいました。
不正パラメータは無視されるだけなのかもしれません。
参考
コチラを参考にしました。ありがとうございました！
あとがき
WebAPIにGETリクエストするためのURLを調べる流れでした！
過去にWebAPIへのアクセスはやったことがあったものの、離れていたので調べ方を忘れて困惑していました……
今回の記事で、楽に調べられたらいいなーという思いで書きました。
よければ参考にしてみてください！
