大規模なデータセットを公開する API を使用する場合は、ページ分割、フィルター処理、並べ替え、キャッシュなどの手法を使用して、API 要求のパフォーマンスを最適化します。
改ページを使用する
API によって、改ページ位置のオプションが異なります。 ページ分割を正しく使用する方法については、API のドキュメントを参照してください。 一般的なページングオプションには、次のようなものがあります。
- ページごとに取得するレコードの数を指定します。
- カーソルを使用して、次のレコード セットを取得します。
- 継続トークンを使用して、データの次のページを取得します。
@odata.nextLink
プロパティには、1 つの応答で返すことができる結果よりも多くの結果がある場合に API が返す URL が含まれます。 このプロパティを使用すると、 @odata.nextLink
プロパティで指定された URL に対して別の API 呼び出しを行うことで、結果の次のページを取得できます。
@odata.nextLink
プロパティが応答に存在しなくなるまで、結果のページを引き続き取得できます。これは、すべての結果を取得したことを示します。
開発プロキシを使用して、アプリケーションで改ページ位置が正しく使用されているかどうかを確認できます。
適切なページ サイズを設定する
ページごとに取得するレコードの数を指定する場合は、適切なページ サイズを選択します。 ページ サイズが小さすぎる場合は、すべてのデータを取得するために多くの API 要求を行う必要があります。 このプロセスは低速で非効率的です。 ページ サイズが大きすぎる場合は、API に負荷がかかりすぎます。 この負担は、タイムアウトやエラーを引き起こす可能性があります。 API 要求の数と要求ごとに取得されたデータの量のバランスを取るページ サイズを選択します。
ページ分割されたデータをキャッシュする
頻繁に変更されないページ分割されたデータを取得する場合は、データ のキャッシュを 検討してください。 キャッシュを使用すると、API 要求の数が減り、アプリケーションのパフォーマンスが向上します。 キャッシュの無効化戦略を実装して、キャッシュ内のデータが最新であることを確認します。
これらのヒントに従うことで、大規模なデータセットを公開し、パフォーマンスのために API 要求を最適化する API を操作できます。
次のステップ
Dev Proxy