휴식 : 대역폭을 절약하기 위해 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! 
     } 
    ...... 
    } 
} 

희망이 있습니다.