ReDoc + SWAGGER +弹簧启动响应示例

Question

目前我正在编写我的应用程序接口文档，我决定用ReDoc实现它。我的应用编程接口是使用SWAGGER构建的，用于我正在使用的Boot..and文档。一切都很好，但是我无法注释我的控制器以在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;
    }
}

Answer 1

最后通过将其添加到控制器@PostMapping来解决此问题

produces = {"application/json"}