java - Spring boot 上的 Swagger - 如何为需要参数的 POST 方法设置示例值？

Question

我有一个 POST 方法 /predict

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

现在在 Swagger UI 上我只看到 Example Value 下的空 map

我有一个名为 RequestInput 的类(class)具有输入的结构。但我却做不到

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

因为Map<String, Object> inputs是 POST 请求的预期输入。我试过了

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

它将显示RequestInput在 Example Value但预测会失败，因为它检测到 RequestInput作为参数，它将抛出 nullpointerexception

Answer 1

您可以使用添加 @ApiParam 注释，例如

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