残り：帯域幅を節約するためにJson応答にファイリングする

Question

私はrestfullではなく、休憩サービスを持っています。 モジュールはステートレスであり、いくつかの残りのエンドポイントを公開するだけです：要求を受け取り、それを変換し、外部エンドポイントを呼び出してから、Jsonレスポンスを作成します。

応答はかなり冗長で、一部のフィールドはかなり大きいということです。

私は、要求レベルでフィルタリングを提供するように求められました。そのため、応答には要求されたデータのみが含まれています。私の公開されたメソッドはPOSTであり、画像はBASE64エンコード、および応答すぎ、画像、および他の多くの分野を含めることができ受け入れる：：ちょうど例を提供するために、

request: { image="<here a long BASE64 encoded request>"} 

response: {result="success", 
    message="it was a success", 
    responseImage="<another base64 encoded image>", 
    longArray1=[ 
     {first="...", second="...", third="..."}, 
     {first="...", second="...", third="..."}, 
     ....many! 
    ], 
    longArray2=[ 
     {first2="...", second2="...", third2="..."}, 
     {first2="...", second2="...", third2="..."}, 
     ....many! 
    ] 
} 

私が欲しいものさ車輪を再構築しないでください。消費者がどのフィールドを応答として受け取るかを事前に選択し、応答の帯域幅を節約できるように、クエリーを作成する既知のパターン（queryStringに、またはJsonリクエストに何かを追加する方法）がありますか？

Answer 1

Filterクラスを持つというアイデアは良いことです。 Filterクラスはレスポンスオブジェクトを反映するフィールドを提供し、提供されていないフィールドにはデフォルトを使用します。例えば。あなたのapiのユーザーがjsonのシリアライズされたフィルターオブジェクトをリクエストで渡さない場合でも、デフォルトのフィルターでデータを受け取る必要があります。あなたの例を拡大すると、要求は次のようになります

request: { 
    image="<here a long BASE64 encoded request>", 
    requestFilters:{ 
    responseImage="<another base64 encoded image>", 
    longArray1={ firstFilter:"PASSED_ONLY", 
      secondFilter:"FAILED_ONLY",    
      ....many! 
     }, 
    longArray2={ // using defaults for firstFilter and secondFilter 
      thirdFilter="PASSED", 
      fourthFilter="FAILED", 
      ....many! 
     } 
    ...... 
    } 
}