複雑なRESTful検索メソッドを実行する適切な方法は何ですか？

RESTの原則に従って、いくつかの基準を使用して検索を行い、結果をクライアントに返すAPIのGETメソッドを作成します。問題は、基準に最大14個のパラメーターを設定できることです。そのうちの1つは複雑なオブジェクトのリストです。

• これらの複雑なオブジェクトをURLパラメータとの間でエンコード/デコードできるかどうかさえわかりません。

• URLが取得できる時間は計算しませんでしたが、十分に大きく、URLの長さの制限に達すると確信していますか？

また、検索は結果を「リアルタイム」で表示する必要があります。つまり、ユーザーが検索フォームから何かを変更するたびに、「検索」ボタンを押さなくても新しい結果を表示できるはずです。

これらの点を明確にして、多くのパラメーターを使用して安らかな検索方法を作成することをお勧めしますか？

あなたが私の答えを読む前に、@ Neilに同意したと言いたいです。戦いを選択する必要があります。私たちは通常、最善を尽くしたいと考えていますが、時には議論の余地が少なすぎて、意思に反した決定を下す必要があります。

とにかく、ニールの答えで、私はもう一つのことを見逃しています。ドキュメント。開発者がPOSTリクエスト/searchが安全であることを確認するためだけです。

そうは言った。

1. GETする機会を与える

GET最初にオプションを検討してください。この質問URLの最大長を確認してください。最長のクエリ文字列が2000文字より長いかどうかを評価します。そうでなく、そうなると思わない場合は、に進みGETます。いように見えるかもしれませんが、少なくともURLをブックマークできます。もちろん、メソッドのセマンティクス（べき等、安全、キャッシュ）から派生したすべての利点があります。

1.1クエリ文字列をエンコードしてみてください

たとえば、base64。javascript でもbase 64エンコーディングがサポートされています。

これがどのように機能するかです：

1. すべてのフィルターを使用してJSONを構築し、正規化します。
2. 文字列に解析する
3. エンコードする
4. エンコードされたJSONを要求パラメーター（/search?q=SGVsbG8gV29ybGQh....）として送信します。
5. サーバー側で、パラメーターqをデコードします。
6. JSON文字列をデシリアライズします

以前は、可能な限り長いJSON文字列を作成し、エンコードして長さを取得していました。エンコードされた文字列がURLに収まるかどうかを評価します。テストするために、Fiddle.jsに次のスニペットを実装しました。（私はそれがまだうまくいくことを願っています）¹

Base 64エンコードは確定的で可逆的であるため、衝突の可能性はありません。

エンコードされたクエリを使用すると、検索をDBに保存したり、URLをブックマークしたり、リンクを共有したりすることもできます。もちろん、文字列をエスケープ/エスケープする必要はありません。

1.2エイリアスで試してください

REST APIの設計方法に関するこのブログを読んで、もう1つの選択肢を思い出しました。一般的なクエリのエイリアス。

これらは次の理由で面白いと思う

• クエリ文字列の長さを短くしてください。APIをよりクリーンで使いやすいものにします

  GET / tickets /？status = closed＆closedAt = xxx vs GET / tickets / recently-closed /

• より多くのエイリアスまたはより多くの要求パラメーターと組み合わせ可能。

  GET / tickets /？status = closed＆closedAt = xxx＆within = 30min vs GET / tickets / recently-closed /？within = 30min

• エイリアスとエンコードされたクエリ文字列を組み合わせることができます

  GET / tickets /？status = closed＆closedAt = xxx＆within = 30min vs GET / tickets / recently-closed /？q = SGVsbG8g ...

^{1：JSONを使用しましたが、サーバー側でデシリアライズできるとすぐに他の形式を使用できます。}

ハンマーしか持っていない場合、すべてが釘のように見えます。ここでの問題は、検索ページをRESTfulなページに変えようとしていることであり、これはRESTfulなデザインが解決する一般的なパターンではないようです。

バックエンドから必要な情報を取得するために、ユーザーが提供するパラメーターを使用してPOSTリクエストを送信するだけです。検索を実行する以外に何もする必要がないと思うので、このページから挿入する必要はありません。ただ、追加/あなた/ユーザーページとの競合に実行するためにリスクはありませんので、あなたのURLの最後に検索します RESTfulなこと。

それは、APIモデルが何であるか、またはなしとして動詞として完全に異なります。

APIがnoneの場合、次のようにオブジェクトのリストを取得できます。

GET: /api/v1/objects

この場合、データを要求パラメーターとして送信する必要があります。そのため、パラメーターをKey-Valueのフラットリストとして記述する必要があります。

GET: /api/v1/objects

key1 : val1
key2.key1 : val 21
key2.key2 : val 22
....

一部のプラットフォームは、カスタムパラメーターリゾルバー（Spring MVCなど）をサポートしています。これは、パラメーターをオブジェクトに変換できます。