More than 1 year has passed since last update.

【学習記録】REST APIを学習する前に必要な関連用語をまとめてみた。

Last updated at 2023-05-30Posted at 2023-05-27

はじめに

こちらは、個人の学習記事になります。以下の点をご承知おき下さい。

学習中の内容になります。必要に応じて都度加筆・修正致します。
出来る限り正しく記載するよう努力致しますが、間違い、ミスも御座います。コメントにてご指摘、アドバイス頂けたら幸いです。
二次情報としての使用は推奨致しません。ご了承ください。

概要

「REST API」について学習していく上で、必要な関連用語をまとめました。超初心者が腑に落ちる様に言い回しを工夫しました。

関連用語

REST APIとは？？

そもそもコレ何だよ？って話です。まずは「REST」と「API」に分けて考えます。

RESTとは、「REpresentational State Transfer」の略でWebシステムの設計方式のことを指す。「具体的に状態を定義した情報のやり取り」的な意味合い。
RESTには「RESTの４原則」というものがあり、これを満たしたものをRESTfulという。基本的にこの4原則を満たしていないものはRESTとは言えない。
そして4つの中で一番大事なのが「ステートレス性」。そのほかの３つ「統一インターフェース」「アドレス可能性」「接続性」について、Web開発に於いては、IDEやフレームワークが勝手に保証してくれるからあまり意識しなくてもいいとのこと。(あくまで開発だけだった場合の話)
ステートレス - 状態管理を行わない。やりとりが一回ごとに完結する。ということ。同じ情報を保持しておかないという感じ？まだ理解しきれない概念。
APIとは「Apprication Programing Interface」。プログラムとアプリのインターフェイス。窓口みたいなもの。Googleアカウントでログインするアプリケーションとか、PayPalで決済出来ちゃうファッションサイトとか、ああいうのもAPIが利用できるお陰という事です。多分。

以上の二つを合体させると「RESTfulな感じで作られたAPI」という事。

因みに、RESTは標準化された仕組みではなくて、あくまでも「Web通信のやり取りにはこんな運用方法で作ってみよう」的な設計思想である。

理解するのに頭の中で境界が分けづらくて難しい概念や。

クエリ文字とは？(クエリパラメータ、URLパラメータ)

クエリパラメータとURLパラメータをカッコでこの項目にしたのには理由があります。
情報にバラつきがあり、案外境界が不明瞭だと感じたからです。それは後述します。

クエリ文字
クエリー「Query」は日本語で「問い合わせ」のこと。今後、SQLがこの辺に関わってくるっぽい。クエリ文字、というか「クエリ文字列」という表現が正しい。URLの末尾に「？＝」をつけて以降サーバーに送る情報を付け足したもの。

<!-- gotopoyoと検索してほしい意味 -->
<!-- ?q=gotopoyoがクエリパラメータ -->
https://www.google.com/search?q=gotopoyo

クエリ文字列とクエリパラメータ、URLパラメータの違い

調べたが、そこそこで意味合いが違うので、厳密に分かれていない。

「？」の後に付ける情報、キーとバリュー(値)のことをそれぞれクエリキーとクエリバリューとか言ったりする。　　

例：上記でいう「？」の後の「q」と「＝」で結んだ「gotopoyo」のこと。

「？」以降の情報を付与した文字列をまとめてクエリ文字列とかクエリパラメーターだという。

URLパラメーターはクエリパラメーターと同義。

パスパラメータ

早速引用になりますがパスパラメータとクエリパラメータの違い

Web通信技術におけるパスパラメーターは、REST APIにおいてURLの一部として指定される変数のことです。URLは、Webサーバー上のリソース（データや機能）にアクセスするためのアドレスのようなものです。パスパラメーターは、そのURLの中で特定の値を指定するために使用されます。
例を挙げると、以下のようなURLがあるとします：

<https://example.com/users/{user_id}>

上記のURLでは、{user_id}という部分がパスパラメーターです。この部分は実際のユーザーのIDに置き換えることができます。たとえば、https://example.com/users/123というURLでは、{user_id}が123に置き換えられています。
パスパラメーターを使用することで、特定のリソースやデータに対して操作や取得を行う際に、動的に異なる値を指定することができます。たとえば、上記の例では、異なるユーザーの情報を取得するために、異なるユーザーIDをパスパラメーターとして指定することができます。
クエリパラメーターとの違いは、パスパラメーターがURLの一部として直接指定される点です。一方、クエリパラメーターはURLの末尾に?を使って指定され、key=valueの形式で追加情報を渡すことができます。
パスパラメーターは、REST APIにおいて特定のリソースに対して操作を行うための柔軟性と拡張性を提供します。また、URLの構造から意味を読み取ることができるため、直感的に理解しやすくなります。
以上が、Web通信技術におけるパスパラメーターの基本的な説明です。

前項にて、クエリパラメータの説明は理解したが、パスパラメーターはURLの一部で、特定のものを表示する役割。一方、クエリパラメーターは、特定もの、表示する画面などの条件を加える役割。似てるけど、若干違う。

実は、講師の方にSpringBootについて質問した時、これに関連する内容を聞いていたので「アレのこと？？」と勝手に納得したので、その内容も以下にまとめました。

Q: ここの部分をなんて呼ぶのが正しいのかわからなかったです。「URLパス」でいいのでしょうか？
A:パス、でよいです。キーワードとしてはREST API URL設計で調べるとよいです！
※私のGitHubリポジトリでのコードで@GetMapping("/nowTime") の("/nowTime") についての質問。

これか！！！！SpringにおいてGetMappingアノテーションで指定していたこれがパスパラメータといことだろう。呼び方は単に「パス」で良い。

HTTPメソッド

HTTPメソッドとは、対象のリソースに何をしたいのか指示する内容を定義したもの。以下のものがHTTPメソッドで、それぞれのの指示内容は以下の通り。

・GET-リソースの情報を取得する。
・POST-リソースに新しいを情報を与える。
・PATCH-リソースの情報を部分的に変更する。
・DELETE-指定したリソースを削除する。
その他にも様々なHTTPメソッドがある。割愛。

HTTPメッセージ

HTTPメッセージには、HTTP通信でのやり取りの際の情報が記載されている。記載される内容によって、どこに書かれるか決まったりしている。

HTTPリクエスト
記載順に並んでいる。
リクエストライン - リクエストの一番最初の行に記載される。HTTPメソッド/リクエスト対象(主にURL)/HTTPのバージョン　で記載される。

リクエストヘッダ - クライアント側へ送る付加情報を記載している。基本構造は名前：値の書式になっている。

リクエストライン - 本質的な情報が入るが、入らないこともある。
HTTPレスポンス

記載順。というわけでもないようです。MDNのDocsを確認した感じではそのような図で示されていました。

ステータスライン(ステータス行)-レスポンスの一番最初の行に記載。プロトコルのバージョン/ステータスコード/ステータステキスト(文字列) の順に記載。ステータスコードは後述。

レスポンスヘッダ - 返ってきた情報がどのようなものなのかを示す。基本構造はコロン（;）で区切られているのはリクエストヘッダと同様。

レスポンスボディ(本文) - これに本質的な情報が記載される。返ってきたステータスコードによって記載されない場合もある。

HTTPステータスコード(番台)

HTTPステータスコード - HTTPリクエストに対して返ってくる処理結果。番台で意味が変わってくる。

番台	意味
100(100-199)	情報レスポンス
200(200-299)	成功レスポンス
300(300-399)	リダイレクトメッセージ
400(400-499)	クライアントエラーメッセージ
500(500-599)	サーバーエラーメッセージ

めっちゃ沢山あるので参考リンクに記載します。

参考リンク１
 参考リンク２

通信フォーマット(データ形式)について

通信は、内容の構造を定義しなければやりとりができないので、決められたフォーマットを使って通信をする。主流が以下二つ。テキスト形式でやりとりする。

JSON-「JavaScript Object Notation」の略。人間が読める(読みやすい)、軽量、コーディングが少なく、処理が高速。記述に一定の取り決めがある。　リンク
XML-HTMLと同様のマークアップ言語。HTMLに似たタグを使った記述方法をとる。JSON形式より自由度が高く、情報を詰め込める。　リンク

おわりに

今回は、REST APIを学習する上で必要な基礎中の基礎の用語を学習しました。
この基本知識を元に、これから「Postman」ツールを使ったりする訳ですが、それはまた別でまとめてみます。
他にも、学習の道すがら出会った何だソレ概念や用語もあったのですが、それもまた後日で。
ありがとうございました！

参考

REST APIについて

クエリ文字、クエリパラメータについて

パスパラメータについて

https://zenn.dev/eri_agri/articles/859a3362db8386

HTTPメソッド関連

通信フォーマット(JSON,XML)

You get articles that match your needs
You can efficiently read back useful information
You can use dark theme

What you can do with signing up

【学習記録】REST APIを学習する前に必要な関連用語をまとめてみた。

目次

はじめに

概要

関連用語

おわりに

参考