java - Spring boot 上的 Swagger 2 - 我可以为 API 下显示的所需参数添加句号吗？

Question

我有一个名为 /predict 的 API。

所需参数有时可以是 score1 和 score2 或

info.score1 和 info.score2 取决于我们获取的数据集。

现在我的 localhost:8080/swagger-ui.html 上的样子是

以下是我如何实现它:

@ApiOperation(value="", response=RequestInput.class)
@RequestMapping(value="/predict", method= RequestMethod.POST, produces="application/json", consumes="application/json")
    public ResponseEntity predict(Map<String, Object> inputs, @RequestBody RequestInput requestInput) {
    ...
}

RequestInput.class 看起来像这样

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Getter;

public class RequestInput {
    @ApiModelProperty(notes = "", required = true)
    @Getter private Double score1;
    @ApiModelProperty(notes = "", required = true)
    @Getter private Double score2;
}

我有 2 个问题:

1. 有可能吗

{
  "info.score1":0,
  "info.score2":0
}

如何设置响应部分的示例值？现在它反射(reflect)了 requestInput 上的内容。我希望它是

{
  "finalScore":0
}

Answer 1

关于您的第一个问题:ApiModelProperty 有“名称”，可以设置为显示您想要的属性名称。第二:检查 io.swagger.annotations.ApiResponses 和 io.swagger.annotations.ApiResponse。 ApiResponse 有一个示例属性，也可以设置。关于您的问题的一部分，其中指出您的 api 有时可以是一个值，有时可以是另一个值:说实话，我认为这不可能进入默认的 Swagger 行为。