Swagger on Spring boot - Как мне установить примерное значение для метода POST, для которого требуется параметр?

Question

У меня есть метод POST /predict

public ResponseEntity predict(@RequestBody Map<String, Object> inputs) {...}

Прямо сейчас в интерфейсе Swagger я вижу только пустую карту под Example Value

I есть класс с именем RequestInput, который имеет структуру для входных данных. Но, однако, я не могу сделать

public ResponseEntity predict(@RequestBody RequestInput requestInput) {...}

, поскольку Map<String, Object> inputs является ожидаемым вводом для запроса POST. Я пытался

public ResponseEntity predict(@RequestBody Map<String, Object> inputs, @RequestBody RequestInput requestInput) {...}

В Example Value будет отображаться RequestInput, но прогноз не удастся, потому что он обнаружил RequestInput в качестве параметра и выдаст nullpointerexception

Answer 1

Вы можете использовать добавить @ApiParam аннотацию что-то вроде

public ResponseEntity predict(@ApiParam(defaultValue = "{\"key\":\"value\"}") @RequestBody Map<String, Object> inputs) {...}