クエリパラメータ

絞り込みはパスに入れない

フリマで「靴」を探したいとき、こういうパスを作りたくなります。

/items/search/靴

ですが条件が増えると破綻します。カテゴリでも絞りたい、価格の上限も付けたい、となったときにパスの形が決められません。

絞り込みの条件は、パスではなくクエリパラメータで渡します。

/items?keyword=靴&category=shoes

? から後ろがクエリです。& で区切っていくつでも並べられ、順番も問いません。

パスとクエリの使い分け

そのものを指すのがパス、条件を添えるのがクエリです。/items は条件が付いても /items のままなので、リソースの構造が崩れません。

req.query から読む

読み方は req.params とよく似ています。

app.get("/items", (req, res) => {
  const keyword = req.query.keyword;
  const category = req.query.category;
});

?keyword=靴 なら req.query.keyword は "靴" です。

無いときは undefined になる

クエリは付いていないこともあります。/items とだけ呼ばれたら req.query.keyword は undefined です。

ですから、無いときにどうするかを必ず決めます。

const keyword = req.query.keyword || "";

|| は「左が空っぽなら右を使う」という書き方です。これで、条件が無いときは絞り込まない、という自然な形になります。

こちらも文字列で届く

第4章の req.params と同じで、クエリの値もすべて文字列です。

const limit = req.query.limit;      // "5"
const limit2 = Number(req.query.limit); // 5

数として使うなら直します。この取り違えは、次のレッスンの並び替えとページングでも効いてきます。

手を動かす

演習では、キーワードとカテゴリで商品を絞り込む API を作ります。条件が無いときの振る舞いにも気を配ってください。

1. keyword があれば name にその文字が含まれるものだけに絞る
2. category があれば category が一致するものだけに絞る
3. どちらも無ければ全件を返す(返す項目は id name category の 3 つ)