Strapi のインタラクティブツールでクエリ URL を組み立てる

REST API では多くのパラメータを組み合わせられるため、クエリ URL が長く複雑になりがちです。

Strapi のコードベースでは `qs` ライブラリ でネストした JavaScript オブジェクトをパース・文字列化しています。複雑なクエリ URL は手入力より qs で生成することを推奨します。

次のインタラクティブなクエリビルダーで URL を自動生成できます。

1. 用途に合わせて Endpoint と Endpoint Query Parameters の値を書き換えます。
2. Copy to clipboard をクリックし、入力に応じて更新される Query String URL をコピーします。

パラメータの使い方

REST API のパラメータ一覧 と、各パラメータのドキュメントを参照すると理解しやすくなります。

Endpoint:Please keep the /api/ part unless you explicitly configured it differently in your project.

Endpoint Query Parameters:

{
sort: ['title:asc'],
filters: {
  title: {
    $eq: 'hello',
  },
},
populate: {
  author: {
    fields: ['firstName', 'lastName']
  }
},
fields: ['title'],
pagination: {
  pageSize: 10,
  page: 1,
},
status: 'published',
locale: ['en'],
}

Feel free to modify the code above.

Query String URL:

Note

既定のエンドポイントパスは /api/ で始まり、API 設定の rest.prefix で変更していない限りそのままにしてください。
例: 既定の API プレフィックスで books コレクションタイプをクエリする場合、Endpoint に /api/books と入力します。

免責

このページの qs とインタラクティブクエリビルダーは次の限界があります。

• 構文エラーをすべて検出できるわけではない
• プロジェクトで使えるパラメータや値を知らない
• オートコンプリートはない

現状は、JavaScript オブジェクトをインラインのクエリ文字列 URL に変換するための補助です。生成した URL が必ずしも API で期待どおりの結果を返すとは限りません。