ReDoc + SWAGGER + Spring Boot-响应样本

问题描述 投票:0回答:1

目前,我正在处理我的API文档,因此决定使用ReDoc来实现它。我的API使用Spring Boot..and建立,而我使用的是SWAGGER文档。一切都很好,但是我无法对Controller进行注释,以在ReDoc文档的右侧显示“响应样本”部分。我尝试在DTO中添加示例,例如:

@JsonIgnoreProperties(ignoreUnknown = true)
    public class DocumentResponse {

        @ApiModelProperty(notes = "XML reuslt", name = "xmlResult", example = "asdasd", dataType = "java.lang.String")
        private String xmlResult;

这是我的控制器的外观:

@Api(tags = {"Document"})
@RestController
@CrossOrigin("")
@RequestMapping("/doc")
public class DocumentController {

    @PostMapping(value = "/doc-create", consumes = {"application/json"})
    @ApiOperation(value = "docCreate", notes = "Create Document", response = DocumentResponse.class)
    @ApiResponses(value = {
            @ApiResponse(code = 200, message = "Document success!", response = DocumentResponse.class),
            @ApiResponse(code = 201, message = "Document created!", response = DocumentResponse.class),
            @ApiResponse(code = 401, message = "Unauthorized!", response = DocumentResponse.class),
            @ApiResponse(code = 403, message = "Forbidden!", response = DocumentResponse.class),
            @ApiResponse(code = 404, message = "Not found!", response = DocumentResponse.class)})
    public @ResponseBody DocumentResponse docCreate(@RequestBody DocumentRequest request) {
        return null;
    }
}
spring-boot swagger springfox redoc
1个回答
0
投票

最终通过将其添加到控制器@PostMapping中来解决:

produces = {"application/json"}
© www.soinside.com 2019 - 2024. All rights reserved.