Springfox/Swagger中用于返回ObjectNode的自定义响应模型

Question

我想使用Swagger为我的Spring Boot API提供一个API文档。我设法让Springfox 2.3.0正常工作，除了返回ObjectNode的控制器外，其他一切都正常工作。Swagger尝试将返回的类（ObjectNode）转换为JSON表示，结果如下：

{
    "array": true,
    "bigDecimal": true,
    "bigInteger": true,
    "binary": true,
    "boolean": true,
    "containerNode": true,
    "double": true,
    "float": true,
    "floatingPointNumber": true,
    "int": true,
    "integralNumber": true,
    "long": true,
    "missingNode": true,
    "nodeType": "ARRAY",
    "null": true,
    "number": true,
    "object": true,
    "pojo": true,
    "short": true,
    "textual": true,
    "valueNode": true
}

现在我知道了，那个大摇大摆的人猜不出我构建的JSON中包含哪些值，但我想以任何形式手动添加正确的ResponseModel。

控制器看起来像这样：

@ApiOperation(value = "NAME", notes = "NOTES")
@RequestMapping(value = "", method = RequestMethod.GET, produces="application/json")
public ResponseEntity<ObjectNode> getComponentByIdentification(
            @ApiParam(name="customerid", required=true, value="")
            @RequestParam (required = true)
            String customerId){
    return new ResponseEntity<ObjectNode>(someService.getCustomer(customerId), HttpStatus.OK);
}

我有没有办法提供一个自定义的ResponseJSON to Swagger，它在文档中显示为模型模式？

Answer 1

我们可以使用springfox中的定制api和swagger模型来给出响应

@PostMapping
@ApiOperation(value = "Create Article", response = ArticleDTO.class)
@ApiImplicitParams({
@ApiImplicitParam(name = "Article DTO", value = "article", required = true, dataType = "com.example.ArticleDTO", paramType = "body")})
    public Article create(@ApiIgnore Article article) {
        return articleRepository.save(article);
    }

这里的请求和响应是ArticleDTO，但将由Jackson转换为Article，但文档将显示ArticleDTO中的内容。JAVA

这就是你要找的吗