Step 6 of 10

リクエストパラメータ

注文の「オプション」指定

「コーヒーをください(GET /coffee)」と言うだけだと、店員さんは困ります。 「ホットで」「ミルク入りで」といったオプションを指定する必要があります。これがパラメータです。

1. パスパラメータ (Path Parameter)

URLの一部として埋め込む、必須の情報です。

  • /users/123: IDが123のユーザー
  • /products/iphone: iPhoneの商品詳細

スラッシュ / で区切られているのが特徴です。

2. クエリパラメータ (Query Parameter)

URLの末尾に ? を付けて指定する、追加のオプションです。

  • /search?keyword=cat: 「cat」で検索
  • /history?limit=10&sort=desc: 履歴を「最新順」に「10件」取得

複数のオプションをつけるときは & でつなぎます。 APIドキュメントを読むときは、「必須なのか、任意なのか」に注目しましょう。

Sources & Further Reading

Review Challenge

APIで「検索結果を最大3件だけ欲しい」と伝える正しい書き方は?