json 문서 응답에서 객체의 특정 속성을 제거합니다. REST API Swagger

Question

안녕하세요. 내 RESTful 웹 서비스 문서화에 swagger를 사용하고 있습니다. json 문서 응답에서 객체의 특정 속성을 제거하는 방법이 있는지 알고 싶습니까? 내게 필요하지 않은 응답을 많이 읽을 수 없기 때문에 내 메소드 param 객체와 응답 모델 (예 : notes, defaultValue, allowableValue, internalDescription 등)에 대해 비틀 거리는 속성이 많다는 의미입니다.

방법 PARAMS 들어

:

 "parameters": [ 
        { 
         "name": "someName1", 
         "description": null, 
         "notes": null, 
         "paramType": "path", 
         "defaultValue": null, 
         "allowableValues": null, 
         "required": true, 
         "allowMultiple": false, 
         "paramAccess": null, 
         "internalDescription": null, 
         "wrapperName": null, 
         "dataType": "string", 
         "valueTypeInternal": null 
        }, 
        { 
         "name": "someName2", 
         "description": null, 
         "notes": null, 
         "paramType": "query", 
         "defaultValue": null, 
         "allowableValues": null, 
         "required": true, 
         "allowMultiple": false, 
         "paramAccess": null, 
         "internalDescription": null, 
         "wrapperName": null, 
         "dataType": "string", 
         "valueTypeInternal": null 
        } 
       ], 

- ==================================== =========================

응답 모델 클래스의 경우

"SomeResponseClass": { 
     "required": false, 
     "name": null, 
     "id": "SomeResponseClass", 
     "properties": { 
      "instanceVariable1": { 
       "required": false, 
       "name": null, 
       "id": null, 
       "properties": null, 
       "allowableValues": null, 
       "description": null, 
       "notes": null, 
       "access": null, 
       "default": null, 
       "additionalProperties": null, 
       "items": null, 
       "uniqueItems": false, 
       "type": "Date" 
      }, 
      "instanceVariable2": { 
       "required": false, 
       "name": null, 
       "id": null, 
       "properties": null, 
       "allowableValues": null, 
       "description": null, 
       "notes": null, 
       "access": null, 
       "default": null, 
       "additionalProperties": null, 
       "items": null, 
       "uniqueItems": false, 
       "type": "double" 
      } 
     } 

Answer 1

JSON 매퍼가 null 속성을 무시하도록 구성되어 있지 않습니다.

@Provider 
@Produces(MediaType.APPLICATION_JSON) 
public class JacksonJsonProvider extends JacksonJaxbJsonProvider { 
private static ObjectMapper commonMapper = null; 

public JacksonJsonProvider() { 
    if(commonMapper == null){ 
     ObjectMapper mapper = new ObjectMapper(); 

     mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL); 
     mapper.setSerializationInclusion(JsonInclude.Include.NON_DEFAULT); 
     mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false); 
     mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); 

     commonMapper = mapper; 
    } 
    super.setMapper(commonMapper); 
    } 
} 

가있는 web.xml 스캔 속성이 매퍼를 추가하고 널 (null)이 사라질 것입니다 다음과 같이 쉽게이 문제를 해결 할 수 있습니다.