フレームワークバックエンド / 2023 ニフティ新人研修

2023年度エンジニア定例フレームワーク回バックエンド

バックエンドパートでは主にAPIについてお話します

話す内容・APIとは？・APIの種類・REST APIとREST原則・リクエストとレスポンス・HTTPメソッド・ヘッダー・URI ・ペイロード
・HTTPステータスコード

APIってなに？

沢山の言葉が出てきますアプリケーションプログラミングインタフェース（API、英: Application Programming Interface）[注釈 1]とは、広義ではソフトウェアコンポーネント同士が互いに情報をやりとりするのに使用するインタフェースの仕様である。 APIには、サブルーチン、データ構造、オブジェクトクラス、変数などの仕様が含まれる。APIには様々な形態があり、POSIX のような国際標準規格、マイクロソフトのWindows APIのようなベンダーによる文書、プログラミング言語の標準ライブラ
リ（例えば、C++のStandard Template LibraryやJava API（英語版）など）がある。商業的に使われる狭義では、各種システムやサービス（ハードウェア、OS、ミドルウェアおよびWebサービス等）を利用するアプリケーションソフトウェア (Application) を開発・プログラミング (Programming) するためのインタフェース (Interface) である[1][2][3][4][5]。こちらの意味では、システムやサービスから直接提供されないもの、例えば言語の標準ライブラリは含まない。 APIはアプリケーションバイナリインタフェース (ABI) とは異なる。APIはソースコードベースだが、ABIはバイナリインタフェースである。例えば、POSIXはAPIだが、Linux Standard Base (LSB) はABIである[6]（LSBはいろいろな規定の集合なので、正確には「LSBには、ABIにまで踏み込んでいる部分もある」）。引用： https://ja.wikipedia.org/wiki/%E3%82%A2%E3%83%97%E3%83%AA%E3%82%B1%E3%83%BC%E3%82%B7%E3%83% A7%E3%83%B3%E3%83%97%E3%83%AD%E3%82%B0%E3%83%A9%E3%83%9F%E3%83%B3%E3%82%B0%E3%82% A4%E3%83%B3%E3%82%BF%E3%83%95%E3%82%A7%E3%83%BC%E3%82%B9

むずかしい

沢山の言葉が出てきます APIってわかりやすく言うと何？

ソフトウェアの一部機能を公開/共有出来る仕組みのこと引用:https://www.itmanage.co.jp/column/application-programming-interface/

APIを使うと何がうれしい？

最新情報の取得が容易になる ⇒情報の確認や更新の手間が省ける開発の効率化に繋がる ⇒機能の開発時間を大幅に短縮できる

APIにはどんな種類がある？

主に2種類 WebAPI（今回説明するのはこちら） ⇒Webサービス機能の一部として提供されているAPI OSが提供するAPI ⇒OS上でプログラミングを行うために用意されたAPI 引⽤︓https://cloudapi.kddi-web.com/magazine/api-types-and-protocols

今回はWebAPIについて説明

多くのWebAPIはREST原則に基づいている REST原則に基づいたものをREST APIと呼ぶ

REST原則って何？

原則1︓ステートレスなクライアント/サーバプロトコル HTTPメッセージの全てがリクエストを理解するための必要な情報を含んでいることから、HTTP通信を⾏うクライアントもサーバもメッセージ間におけるセッションの状態を記憶している必要がありません。 ※ ステートレスと表現していますが、実際には Cookie などを使⽤しセッション状態を管理しています。原則2︓リソースを⼀意なURIにより識別される RESTfulなシステムでは全てのリソース（情報）はURI（Uniform
Resource Identifier）で表現されるユニークなアドレスを持ちます。原則3︓HTTPメソッドで操作⽅法を表現した統⼀されたインターフェースリソースを操作するメソッドは、HTTPで定義されている "GET"、"POST"、"PUT"、"DELETE" などを使⽤します。つまり、情報を操作する命令体系があらかじめ定義されています。原則4︓アプリケーション情報と状態遷移の両⽅を扱えるハイパーメディアの使⽤リソースを様々な形式（HTML、XML、 JSON、バイナリ）で表現できるようにします。また、関連するデータはハイパーメディア（リンク）としてデータに含めることができます。引⽤元︓https://www.infraexpert.com/study/sdn09.html

ちょっとむずかしい

簡単にすると... 原則1︓サーバーとクライアントがデータ交換をする時に、お互いのセッション状態は記憶してなくてもいいよ原則2︓所望のデータを取りたい際に、APIを叩くときのおまじないは⼀意に定まるよ原則3︓APIを叩く際には "GET"、"POST"、"PUT"、"DELETE" を使ってユーザが何をしたいのかをわかりやすくするよ原則4︓アプリケーション情報と状態遷移の両⽅を扱えるハイパーメディアの使⽤リソースを様々な形式（HTML、XML、 JSON、バイナリ）で表現できるようにします。また、関連するデータはハイパーメディア（リンク）としてデータに含め
ることができます

APIの実例を⾒てみる実例として、zipcloudの郵便番号API検索を利⽤︓https://zipcloud.ibsnet.co.jp/doc/api

郵便番号検索のAPI $ curl “https://zipcloud.ibsnet.co.jp/api/search?zipcode=7830060” { "message": null, "results": [ {
"address1": "⾼知県", "address2": "南国市", "address3": "蛍が丘", "kana1": "ｺｳﾁｹﾝ", "kana2": "ﾅﾝｺｸｼ", "kana3": "ﾎﾀﾙｶﾞｵｶ", "prefcode": "39", "zipcode": "7830060" } ], "status": 200 }

何が起きているの︖

APIの概念について例⽰

ファストフードの注⽂に例えると

②商品 ①注⽂お客店員⾏動︓購⼊注⽂︓ハンバーガーセット⾷べる場所︓店内

所定の注⽂をすると、きちんと商品が貰える

APIも同じ

所定の注⽂（リクエスト）をすると、きちんと商品（レスポンス）が貰える

レスポンスリクエストエンドポイント通信元 URI プロトコル︓https ドメイン︓zipcloud.ibsnet.co.jp リソースパス︓api/search パラメータ︓zipcode=7830060 メソッド︓GET
HTTPステータスコード︓200 ヘッダー︓受付⽇時、コンテンツタイプなどヘッダー︓通信元の情報などペイロード︓住所や読み⽅など（ペイロード︓詳細な情報）

知らない⾔葉が沢⼭ある

ひとつひとつ⾒ていく

HTTPレスポンス︓200 ヘッダー︓受付⽇時、コンテンツタイプなどヘッダー︓通信元の情報などペイロード︓住所や読み⽅など（ペイロード︓詳細な情報） URI プロトコル︓https ドメイン︓zipcloud.ibsnet.co.jp リソースパス︓api/search パラメータ︓zipcode=7830060 HTTPレスポンス︓200 ヘッダー︓受付⽇時、コンテンツタイプなどヘッダー︓通信元の情報などペイロード︓住所や読み⽅など（ペイロード︓詳細な情報） URI プロトコル︓https ドメイン︓zipcloud.ibsnet.co.jp リソースパス︓api/search パラメータ︓zipcode=7830060 HTTPステータスコード︓200 ヘッダー︓受付⽇時、コンテンツタイプなどヘッダー︓通信元の情報などペイロード︓住所や読み⽅など（ペイロード︓詳細な情報）

メソッド（HTTPメソッド）とは︖

リクエストを⾏う際に「どのような操作を⾏いたいか」を決定するために使⽤します

主に４つのメソッドが使われている HTTPメソッド機能 GET リクエスト先の情報（リソース）を取得する際に使⽤する POST 新しいリソース情報を送り込む PUT リソース情報を新しい情報で置き換える
DELETE リソース情報を削除する

ヘッダー︓受付⽇時、コンテンツタイプなどヘッダー︓通信元の情報などペイロード︓住所や読み⽅など（ペイロード︓詳細な情報） URI プロトコル︓https ドメイン︓zipcloud.ibsnet.co.jp リソースパス︓api/search パラメータ︓zipcode=7830060 ヘッダー︓受付⽇時、コンテンツタイプなどヘッダー︓通信元の情報などペイロード︓住所や読み⽅など（ペイロード︓詳細な情報） URI プロトコル︓https ドメイン︓zipcloud.ibsnet.co.jp リソースパス︓api/search パラメータ︓zipcode=7830060 ヘッダー︓受付⽇時、コンテンツタイプなどヘッダー︓通信元の情報などペイロード︓住所や読み⽅など（ペイロード︓詳細な情報） HTTPステータスコード︓200

ヘッダーとは︖

クライアントやサーバーが HTTPリクエストやレスポンスで追加情報を渡すことができる

代表的なヘッダー情報・サーバーとやりとりするための認証情報・やりとりした⽇時・クッキー・などなど...

郵便番号検索のAPIのレスポンスヘッダ $ curl --head "https://zipcloud.ibsnet.co.jp/api/search?zipcode=7830060" HTTP/2 200 access-control-allow-origin: * content-type:
text/plain;charset=utf-8 x-cloud-trace-context: c948f2b622f8591dae93a05b17ce65c2 content-length: 290 date: Fri, 14 Jul 2023 04:41:35 GMT server: Google Frontend

URIとは︖

名前または場所を識別する書き⽅のルールの総称 (URN U URL) = URI

ヘッダー︓受付⽇時、コンテンツタイプなどヘッダー︓通信元の情報などペイロード︓住所や読み⽅など（ペイロード︓詳細な情報） URI プロトコル︓https ドメイン︓zipcloud.ibsnet.co.jp リソースパス︓api/search パラメータ︓zipcode=7830060 ヘッダー︓受付⽇時、コンテンツタイプなどヘッダー︓通信元の情報などペイロード︓住所や読み⽅など（ペイロード︓詳細な情報） URI プロトコル︓https ドメイン︓zipcloud.ibsnet.co.jp リソースパス︓api/search パラメータ︓zipcode=7830060 ヘッダー︓受付⽇時、コンテンツタイプなどヘッダー︓通信元の情報などペイロード︓住所や読み⽅など（ペイロード︓詳細な情報） HTTPステータスコード︓200

ペイロードとは︖

パケット通信においてパケットに含まれるヘッダやトレーラなどの付加的情報を除いた、データ本体のこと

<リクエスト> POSTやPUTなどのHTTPメソッドを使う場合、ここに各種情報を⼊れて叩く <レスポンス> 欲しいデータがこの中に⼊っているよ

HTTPレスポンス︓200 ヘッダー︓受付⽇時、コンテンツタイプなどヘッダー︓通信元の情報などペイロード︓住所や読み⽅など（ペイロード︓詳細な情報） URI プロトコル︓https ドメイン︓zipcloud.ibsnet.co.jp リソースパス︓api/search パラメータ︓zipcode=7830060 HTTPレスポンス︓200 ヘッダー︓受付⽇時、コンテンツタイプなどヘッダー︓通信元の情報などペイロード︓住所や読み⽅など（ペイロード︓詳細な情報） URI プロトコル︓https ドメイン︓zipcloud.ibsnet.co.jp リソースパス︓api/search パラメータ︓zipcode=7830060 HTTPステータスコード︓ 200 ヘッダー︓受付⽇時、コンテンツタイプなどヘッダー︓通信元の情報などペイロード︓住所や読み⽅など（ペイロード︓詳細な情報）

HTTPステータスコードとは︖

レスポンスに表⽰される3桁の番号のことクライアントのWebブラウザとサーバ間ではHTTPリクエストに対してレスポンスを返す

ステータスコード状態説明有名なステータスコード 100番台正常クライアントからのリクエストを受け⼊れ可能で、継続して処理されている状態 100
Continue リクエスト継続可能 200番台正常クライアントからリクエストがサーバに送られ理解されて受理された状態です。 200 OK リクエストが正常に処理できた 300番台正常リクエストを完了させるために追加的な処理が必要です。 300 Multiple Choice リクエストに対して複数のレスポンスがあることを示す 400番台エラークライアント（ユーザ）側で操作や⼊⼒に不備があった際に出てしまうエラー 404 Not Found Webページが見つからない 500番台エラーサーバ側で問題が⽣じていている際に出てしまうエラー 500 Internal Server Error 何らかのサーバ内で起きたエラー

HTTPレスポンス︓200 ヘッダー︓受付⽇時、コンテンツタイプなどヘッダー︓通信元の情報などペイロード︓住所や読み⽅など（ペイロード︓詳細な情報） URI プロトコル︓https ドメイン︓zipcloud.ibsnet.co.jp リソースパス︓api/search パラメータ︓zipcode=7830060 HTTPレスポンス︓200 ヘッダー︓受付⽇時、コンテンツタイプなどヘッダー︓通信元の情報などペイロード︓住所や読み⽅など（ペイロード︓詳細な情報） URI プロトコル︓https ドメイン︓zipcloud.ibsnet.co.jp リソースパス︓api/search パラメータ︓zipcode=7830060 HTTPステータスコード︓ 200 ヘッダー︓受付⽇時、コンテンツタイプなどヘッダー︓通信元の情報などペイロード︓住所や読み⽅など（ペイロード︓詳細な情報）

パラメータとは

APIが処理に使うための情報主に3種類パスパラメータ ⇒URLドメイン以下のパス例)https://support.nifty.com/mypage/ クエリパラメータ ⇒URLの”?”以降例)https://zipcloud.ibsnet.co.jp/api/search?zipcode=7830060 ペイロード ⇒HTTPリクエストの際に送るデータ本体

パラメータとは

もう⼀度APIの実例を⾒てみる

郵便番号検索のAPI $ curl https://zipcloud.ibsnet.co.jp/api/search?zipcode=7830060 { "message": null, "results": [ {
"address1": "⾼知県", "address2": "南国市", "address3": "蛍が丘", "kana1": "ｺｳﾁｹﾝ", "kana2": "ﾅﾝｺｸｼ", "kana3": "ﾎﾀﾙｶﾞｵｶ", "prefcode": "39", "zipcode": "7830060" } ], "status": 200 }

郵便番号検索のAPI $ curl https://zipcloud.ibsnet.co.jp/api/search?zipcode=7830060 { "message": null, "results": [ {
"address1": "⾼知県", "address2": "南国市", "address3": "蛍が丘", "kana1": "ｺｳﾁｹﾝ", "kana2": "ﾅﾝｺｸｼ", "kana3": "ﾎﾀﾙｶﾞｵｶ", "prefcode": "39", "zipcode": "7830060" } ], "status": 200 } URI ペイロード HTTPステータスコードレスポンスクエリパラメータパスパラメータ

フレームワーク バックエンド / 2023 ニフティ新人研修

フレームワーク バックエンド / 2023 ニフティ新人研修

More Decks by ニフティ株式会社

Other Decks in Programming

Featured

Transcript

フレームワークバックエンド / 2023 ニフティ新人研修

フレームワークバックエンド / 2023 ニフティ新人研修