Как показать только требуемые параметры в Swagger-UI Поле «Значение»

Question

У меня есть Post метод. Swagger-Ui по умолчанию генерирует пример запроса в JSON со всеми fields от Class.

Я хочу показать там по умолчанию только необязательные поля.

В Swagger-UiModel я ясно вижу, что:

x (integer, optional), 
y (string), 

Некоторые поля являются обязательными, а некоторые нет.

Как я могу достичь этого в Spring MVCSpring Boot app?

Мой Кураж Config:

@Configuration 
@EnableSwagger2 
public class SwaggerConfig 
{ 
    @Bean 
    public Docket api() 
    { 

     return new Docket(DocumentationType.SWAGGER_2). 

       select().apis(RequestHandlerSelectors.any()).paths(PathSelectors.ant("/api/**")).build(); 

    } 
} 

@ApiModelProperty(hidden = true)

скрывает поле - но я не хочу этого. Я только хочу сделать Swagger генерировать JSON, когда я нажимаю Model Schema только на основе None-optional полей.

Answer 1

Отметьте свою модель Jackson's@JsonIgnoreProperties например.

@JsonIgnoreProperties(value = {"field1", ...}) 
public class YourModel { 

    private String field1; 

    private String field2; 

    //getters and setters here 
} 

, чтобы проверить, если предположить field1 является null

ObjectMapper objectMapper = new ObjectMapper(); 
YourModel model = new YourModel(); 

String strField1 = objectMapper.writeValueAsString(objectMapper); 

assertThat(strField1, not(containsString("field1"))); 

См @JsonIgnoreProperties.

Answer 2

Это не функция пользовательского интерфейса Swagger, поэтому нет способа настроить его так, как вы просите. Поэтому рассмотрите возможность изменения исходного кода, чтобы выполнить то, что вы просите в проекте swagger-ui.