Как настроить блок "Образец ответа" в Swagger (Redoc)

Я пытаюсь настроить swagger с помощью Redoc, и все было хорошо, кроме блока "образец ответа", он пуст.

Я знаю, что этот блок основан на сгенерированном 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));
}

Приведенный выше код вернет инвентарь из steam в формате json. Swagger не знает об этом, потому что в моем коде у меня нет сущности, которая описывает это (и это не нужно). Как я могу добавить блок образца пользовательского ответа?

0 ответов

Другие вопросы по тегам