Swagger on Spring boot - 如何為需要參數的 POST 方法設置示例值？

Question

我有一個 POST 方法/predict

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

現在在 Swagger UI 上，我只在Example Value下看到空地圖

我有一個名為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) {...}