まるノート

備忘録も兼ねて、様々なお役立ち情報をまとめています。

【使い方で学ぶ】API とは何かが結構分かった気になる記事

はじめに

本記事では API の使い方を解説します。API って何?って方はまずは下の記事をご覧頂けると幸いです。

API とは何なのか? - まるノート


上の記事でも分かり易く解説したつもりですが、なんとなくもやもやした気持ちがある方も多いのではないかと思います。
自分もそうでしたが、ある程度使ってみることで段々分かったような気がしてくると思います。


本記事ではあくまで API ってなんなのか、ということの理解を深めてもらうための使い方に重点をおいています。
なので本格的な API の利用方法というわけではありませんが、サクッと呼んでいただけると幸いです。


HTTP の仕組み

APIを利用する上で必要な、HTTP の仕組みを簡単に解説します。

HTTPとは、WebサーバーとWebクライアントがデータを通信する方式(プロトコル)です。
以下がHTTP通信の基本で、通常のインターネット通信を行う場合もAPIを利用する場合も同じです。

  • 何に対して ⇒ URL
  • 何をするか ⇒ HTTPメソッド(GET,POST,etc)


HTTPリクエストのデータ構造は以下の通りです。

リクエストライン(1行目) GET,POST などのHTTPメソッド
リクエストヘッダー(2行目~複数行) クライアントの様々な情報
空行 -
メッセージボディ(空行のあとから) POSTデータ
※GETの時はない


通常インターネットを利用する際は、HTTPメソッドのGETメソッドを利用して通信先のサーバーからhtmlファイルなどの情報を取得しています。

API を利用する場合はGETメソッドだけではなく以下のメソッドが利用できます。

・GET:データの取得
・POST:データの作成(APIへの投稿や書き込み)
・UPDATE:データの更新
・DELETE:データの削除


API の利用方法~超基本~

くどいようですが、Webサイトを閲覧する際にはGETメソッドでhtmlファイルなどを取得しています。
そして API を叩いて必要な情報を取得する方法も同じです。 ※GETメソッドを使う場合

Webサイトを閲覧した際、試しに chrome の開発者ツールで「Network」タブを見てみると、
様々な情報をGETメソッドで取得しているのがわかるはずです。


なのでGETメソッドに限りますが、最もお手軽な API の利用方法は、
API を提供しているサイトにアクセスすることです

適当にググったら以下のサイトが見つかりましたので参考に乗せておきます。

ランダムユーザーAPI

https://randomuser.me/

APIのURL:https://randomuser.me/api/

犬の画像

https://dog.ceo/dog-api/

APIのURL:https://dog.ceo/api/breeds/image/random


どちらの API も一見よくわからない文字列が取得されたはずです。
取得したデータは JSON形式と呼ばれるデータです。

JSON形式 「JavaScript Object Notation」の略。開発当初はJavaScriptでの利用を前提に作られたテキストフォーマットだった。
軽量で使いやすくデータ構造もわかりやすいため、CやJava、Pythonなど、多くのプログラミング言語で広く活用されている。

もっとも基本的な形式は、データのキーと値を{ }の中にコロンで区切って記載する。

{"Key": "Value"}


少しずつ API とは何かが実感できてきたでしょうか。

ちなみに、公開されている多くの API はAPIキーというものが必要です。 そのためにちょっと手間ではありますが利用登録が必要です。

また様々なパラメータが必須の場合もありその場合は JavaScript や PHP といったプログラムから実行します。


TwitterAPI のフォロワー一覧をJSON形式で取得できる APIなど、様々なAPIが公開されておりまとめサイトもたくさんあります。
またAPI を利用するためのプログラムも自分でコードを組まなくても公開されていますので、ご興味ある方は是非ググってみるとより理解が深まると思います。


API の利用方法~POSTMANの利用~

前項では直接 API にアクセスしてJSONデータを取得しただけですが、POST、UPDATE、DELETE を利用するには専用のツールやプログラムを利用する必要があります。

代表的なAPIツールの一つとしてPOSTMANというツールを紹介します。
API の利用や理解のためには是非とも導入をお勧めします。


POSTMAN

Download Postman | Get Started for Free

特に設定項目もなく、ダウンロードした exe を実行すると、下記にポストマンがインストールされます。

C:\Users{ユーザ名}\AppData\Local\Postman\Postman.exe


早速起動すると以下の画面になります。ユーザー登録してもいいですし、
下図枠線を押下して進んでも大体のことはできます。


早速 API の利用ができる画面に進みます。GETを始めとする様々な メソッドが利用できます。


例えば上述した「ランダムユーザーAPI」からGETコマンドでデータを取得したい場合、
URLを指定して「Send」ボタンを押下すると即結果が返ってきます。
(GETだけならブラウザでアクセスした方が簡単ですが、、)


POSTMANの詳しい説明はかなり省略していますが、とりあえずイメージはこんな感じです。


おわりに

他のHTTPメソッドを使う場合はさらにいくつかのパラメータが必要だったり、多くの API ではAPIキーが必要だったりともうひと手間かかります。

POSTリクエストを送る場合は、そもそも投稿したいデータをメッセージボディに追加しておく必要があります。

本記事ではあくまで API の雰囲気を掴むための内容なのでそれらは割愛しますが、
POSTMANの使い方などはまた別記事にしたいと思います。

最後までご覧頂きありがとうございました。