普段何気なく使ってますが、改めて整理してみました、備忘録です。
パラメーターとは
処理結果に影響を与える外部から投入される変動要素
のこと
数学の世界でも使われますが、プログラムの世界では引数(仮引数)
のこと。
APIのリクエストパラメータ
API引数とも呼ばれる。
APIはアプリケーション同士が通信するためのインターフェースであり、リクエストパラメーターはその通信を具体的に指示する役割を果たします。
主に以下の3種類がある
・パスパラメーター
・クエリパラメーター
・ボディパラメーター(リクエストボディ)
パスパラメーター
パスパラメータは、URLパスの一部を利用するパラメータ
URLでリソースを特定するのに使われる。
https://hoge.com/api/employees/15
クエリパラメーター
クエリパラメータはURLの最後に「?」から始まる形式で付け加える。
クエリ文字列は、KEY=VALUE
形式
複数のパラメータを記載したい場合には、&
で区切る
https://hoge.com/api/employees?role=sales&gender=male
ボディパラメーター(リクエストボディ)
リクエストの本文に含まれるパラメーターで、POST、PUTなど大量のデータを送信する場合に使用されます。JSON形式で渡す。
例:POST /employees
{ "name": "Taro Yamada", "age": 30, "role": "engineer", "gender": "male" }