APIとは？バックエンドでよく出てくる単語

プログラミングを勉強しているときに「API」という言葉を聞いたことはありませんか？

APIとは何ぞやと一言で表すならば、異なるソフトウェア同士がデータを交換したり機能を利用し合ったりするための「共通のルール」や「取り決め」です。

・・・。

正直よくわからないですよね。今回はそんなAPIについての記事となります。

APIの定義について

API（Application Programming Interface）は、異なるソフトウェアやアプリケーションが互いにデータを交換し、機能を利用し合うための「共通のルール」や「取り決め」を指します。

例えるなら、異なる言語を話す人たちが英語のような共通の言葉を使ってコミュニケーションを取るように、APIはソフトウェア同士のコミュニケーションを円滑にします。

APIは、特定の機能やデータにアクセスするための手段を提供します。

これにより、開発者は既存のサービスやデータを利用し、効率的にアプリケーションを構築できるのです。

APIの役割

APIの主な役割は、以下の通りです。

機能の再利用

APIを使うことで、既存の機能やデータを再利用することができます。

例えば、地図情報を利用するためにGoogle MapsのAPIを使うことで、自分で地図データを作成する必要がなくなります。

システム間の連携

APIを利用することで、異なるシステムやアプリケーション同士がデータをやり取りして連携することができます。

例えば、オンラインショッピングサイトが決済サービスと連携するためにAPIを利用することが挙げられます。

効率的な開発

APIを活用することで、開発時間やコストを大幅に削減できます。

開発者は、既存のAPIを組み合わせて新しいサービスを構築することができるため、一から全てを開発する手間が省けます。

APIの歴史と発展

APIの概念は古くから存在しますが、特にインターネットの発展とともにその重要性が増してきました。

以下はAPIの主な歴史的発展の概要です。

1.初期のAPI

1960年代から1970年代にかけて、初期のコンピュータシステムでAPIの概念が使われ始めました。

当時は主に、特定のソフトウェアライブラリやオペレーティングシステムが提供する機能にアクセスするための手段として使われていました。

2.インターネットの普及

1990年代にインターネットが普及すると、ウェブサービスやウェブAPIが登場しました。

SOAP（Simple Object Access Protocol）やXML-RPC（XML Remote Procedure Call）などのプロトコルが開発され、異なるシステム間でのデータ交換が容易になりました。

3.RESTful APIの登場

2000年代には、よりシンプルで軽量なREST（Representational State Transfer）アーキテクチャが登場しました。

RESTful APIは、HTTPを利用してデータをやり取りするため、より直感的で使いやすいことから急速に普及しました。

現在と未来

今日では、APIはクラウドサービス、モバイルアプリケーション、IoTデバイスなど、様々な分野で重要な役割を果たしています。

APIエコノミーの拡大により、APIを提供する企業とそれを利用する開発者の関係が深まり、新しいビジネスモデルが生まれています。

APIの構成要素

エンドポイントとは

エンドポイントとは、APIが提供する機能やデータにアクセスするための特定のURLのことです。

エンドポイントはリソース（データの対象）を表しており、例えばユーザー情報や記事リストなどを取得するための道筋となります。

例えば、ユーザー情報を取得するエンドポイントはhttps://api.example.com/usersのようになります。

HTTPメソッドの種類

HTTPメソッドは、APIとやり取りする際にどのような操作を行うかを指定するための動詞です。

主なHTTPメソッドには以下の4つがあり、これはRESTfulでも解説したものと同じです。

• GET: リソースを取得します。例えば、全てのユーザー情報を取得する際に使います。
• POST: 新しいリソースを作成します。例えば、新しいユーザーを登録する際に使います。
• PUT: 既存のリソースを更新します。例えば、ユーザー情報を更新する際に使います。
• DELETE: リソースを削除します。例えば、特定のユーザーを削除する際に使います。

リクエストとレスポンス

APIを利用する際には、クライアントからサーバーへのリクエストと、サーバーからクライアントへのレスポンスが重要です。

• リクエスト: クライアントがサーバーに送信するデータや命令です。例えば、GET https://api.example.com/usersというリクエストを送ると、全てのユーザー情報を要求します。
• レスポンス: サーバーがクライアントに返すデータです。例えば、リクエストに対するレスポンスとして、ユーザー情報のリストがJSON形式で返されます。

パラメータの種類

APIリクエストには、特定のデータを指定するためのパラメータが含まれることがあります。主なパラメータの種類には以下があります：

• クエリパラメータ: URLの末尾に追加され、特定の条件でフィルタリングや検索を行います。例えば、?city=Tokyoのように使用されます。
• パスパラメータ: URLの一部として使用され、特定のリソースを指定します。例えば、/users/{id}の{id}部分がパスパラメータです。
• ボディパラメータ: POSTやPUTリクエストの本文に含まれるデータです。新しいリソースを作成する際に使用されます。

認証と認可

APIを利用する際には、セキュリティを確保するために認証と認可が重要です。

• 認証: ユーザーが正当なアクセス権を持っていることを確認するプロセスです。APIキーやトークンを使用して行われます。
• 認可: 認証されたユーザーが特定のリソースや機能にアクセスできる権限を持っているかを確認するプロセスです。認証後にアクセス権限をチェックします。

APIの基本的な使い方

APIキーの取得

多くのAPIは、利用する前に認証のためのAPIキーを取得する必要があります。APIキーは、一意の識別子であり、APIサービスプロバイダーのウェブサイトでアカウント登録を行い、アプリケーションを作成することで取得できます。例えば、OpenWeatherMapの天気情報APIを利用する場合、OpenWeatherMapのサイトでアカウントを作成し、「APIキー」を発行する手続きを行います。このキーをリクエストに含めることで、正当なユーザーであることを証明します。

リクエストの送信

APIリクエストは、特定のエンドポイントに対してHTTPメソッドを使って送信されます。リクエストには、必要なパラメータや認証情報（APIキーなど）を含めます。以下は、天気情報を取得するためのリクエストの例です：

GET https://api.openweathermap.org/data/2.5/weather?q=Tokyo&appid=YOUR_API_KEY

この例では、GETメソッドを使用して、https://api.openweathermap.org/data/2.5/weatherというエンドポイントに対してリクエストを送信し、東京の天気情報を取得しています。また、appidというクエリパラメータにAPIキーを含めています。

レスポンスの解析

APIからのレスポンスは通常、JSON形式で返されます。レスポンスを受け取ったら、その内容を解析して必要な情報を抽出します。

以下は、天気情報APIからのレスポンスの例です：

{
  "weather": [
    {
      "description": "clear sky"
    }
  ],
  "main": {
    "temp": 288.55
  },
  "name": "Tokyo"
}

この例では、weatherフィールドには天気の状態（clear sky）が、mainフィールドには温度（288.55K）が含まれています。これらのデータをアプリケーション内で表示したり、他の処理に利用します。

エラーハンドリング

APIリクエストが失敗した場合やエラーが発生した場合に備えて、適切なエラーハンドリングを行うことが重要です。APIレスポンスには、エラーメッセージやエラーコードが含まれていることがあります。以下は一般的なエラーコードの例です：

• 400 Bad Request: リクエストが無効です。
• 401 Unauthorized: 認証情報が不足している、または無効です。
• 404 Not Found: リクエストしたリソースが見つかりません。
• 500 Internal Server Error: サーバー側でエラーが発生しました。

エラーが発生した場合は、レスポンスの内容を確認し、適切なエラーメッセージを表示するか、再試行するなどの対処を行います。

例1: 天気情報を表示するアプリ

想像してみてください。あなたは天気情報を表示するアプリを作りたいとします。

このアプリがリアルタイムの天気情報を取得するためには、天気データを持っているサービスにアクセスする必要がありますよね。このときに役立つのがAPIです。

天気情報を提供するサービス（例えばOpenWeatherMap）はAPIを公開しており、そのAPIを利用することで、あなたのアプリは簡単に天気情報を取得できます。

APIを使うことで、自分で天気データを収集・更新する手間を省き、既存のサービスの機能を利用できるのです。

基本的なAPIの構成

エンドポイント:

APIが提供する機能やデータにアクセスするためのURLです。

例えば、天気情報を取得するエンドポイントはhttps://api.openweathermap.org/data/2.5/weatherのようになります.

HTTPメソッド:

APIとのやり取りに使う動詞です。一般的なメソッドには以下があります。

GET: データを取得する。

POST: 新しいデータを作成する。

PUT: 既存のデータを更新する。

DELETE: データを削除する。

リクエスト:

クライアント（あなたのアプリ）がAPIに送るデータです。天気情報を取得する場合、リクエストには都市名やAPIキーが含まれることがあります。

レスポンス:

APIがクライアントに返すデータです。通常、JSON形式で返されます。天気情報の例では、気温や天気の状態などが含まれます。

お疲れ様でした！ここまで読んでみていかがでしたか？

十二分にAPIについて理解できたあなた！さてはAPIについて知っていましたね？

当然この説明では全く理解できませんでしたので、以下からはAPIをレストランで例えて説明しています。

APIをレストランに例えて解説

レストランのメニュー

• APIのドキュメントは、レストランのメニューのようなものです。メニューを見て、どんな料理が注文できるかを確認するように、APIドキュメントを見て、どんなデータや機能を利用できるかを確認します。

注文とリクエスト

• あなたがレストランに行って料理を注文するように、APIリクエストを送ります。例えば、「このレストランではハンバーガーをください」と注文するのと同じように、「このAPIでは特定のデータをください」とリクエストを送ります。

シェフとサーバー

• レストランのシェフがあなたの注文を受け取り、料理を作るように、APIサーバーはあなたのリクエストを受け取り、データや機能を提供します。

料理とレスポンス

• シェフが料理を作ってあなたに提供するように、APIレスポンスは、リクエストに応じたデータや結果をあなたのアプリに返します。例えば、「ハンバーガーを注文したら、ハンバーガーが運ばれてくる」という感じです。

実際の例

• リクエスト: レストランで「ハンバーガーをください」と注文するのと同じように、APIに「東京の天気をください」とリクエストします。
  • レストランの注文: ハンバーガーをください。
  • APIのリクエスト: GET /weather?city=Tokyo
• レスポンス: シェフがハンバーガーを作って提供するのと同じように、APIはリクエストに応じたデータを返します。
  • レストランの提供: ここにハンバーガーがあります。
  • APIのレスポンス: { "temperature": "20°C", "description": "clear sky" }

このように、APIはアプリケーション同士がデータをやりとりするためのレストランのような仕組みであり、リクエストを送ってデータをもらうという流れです。