Question

我正在尝试使用redoc来设置摇摇欲坠，除了“响应样本”块之外，其他一切都很好，它是空的。

我知道此块基于swagger生成的json。我发现它是空的，因为我在RestController中的方法本身不会返回任何内容，但是它将以JSON格式从另一个服务返回值。

我尝试用Swagger @ApiResponse注释描述响应，但是这样的描述仍然不会显示此块

   @ApiOperation(value = "Get inventory info")

   @ApiResponse(code = 200, message = "Some response")

   @PreAuthorize("hasRole('ROLE_STEAM_API_INVENTORY')")

   @JsonRequestMapping(value = "/{steamId}/{appId}/{contextId}", method = RequestMethod.GET)
public ResponseEntity<String> inventory(@PathVariable("steamId") Long steamId,
                                @PathVariable("appId")Long appId,
                                @PathVariable("contextId") Integer contextId,
                                @RequestParam(name = "legacy", required = false) Short legacy,
                                @RequestParam(name = "lang", required = false) String lang,
                                @RequestParam(name = "count", required = false) Integer count) {
    return ResponseEntity.ok(steamRequestService.getInventory(steamId, appId, contextId, legacy, lang, count));
}

以上代码将以json格式从Steam返回库存。 Swagger不了解它，因为在我的代码中我没有描述它的实体（这是不必要的）。如何添加自定义响应样本块？

如何自定义swagger中的“响应样本”块（redoc）

0 个答案: