Swagger API 응답에서 개체 목록 설정

Swagger API 응답에서 개체 목록 설정

Swagger를 사용하여 API의 응답으로 객체 목록을 보내고 싶습니다.

@ApiResponse(code = 200, message = ApiResponseMessages.ITEM_FETCHED, 
response = "")

수업이 있어요

class Item{
   int id;
   String item_name;
}

저는 다음과 같은 답변을 원합니다.

{
    {
       "id" : 0,
       "item_name" : ""
    }
    {
       "id" : 0,
       "item_name" : ""
    }
    {
       "id" : 0,
       "item_name" : ""
    }
}

어떻게 해야 돼요?어떤 도움이라도 주시면 감사하겠습니다.

다음과 같이 ApiResponse를 설정할 수도 있습니다.

@ApiResponse(code = 200, message = ApiResponseMessages.ITEM_FETCHED,
             response = Item.class, responseContainer = "List"
            )

다음과 같이 반환됩니다.

[
    {
       "id" : 0,
       "item_name" : ""
    },
    {
       "id" : 0,
       "item_name" : ""
    },
    {
       "id" : 0,
       "item_name" : ""
    }
]

새 패키지의 경우:io.swagger.v3.oas.annotations.responses.ApiResponse

이 작업을 수행해야 합니다(와 함께@ArraySchema주석):

@ApiResponse(responseCode = "200", description = "",
            content = {@Content(
                mediaType = "application/json",
                array = @ArraySchema(schema = @Schema(implementation = Bar.class))
            )}
)

사용할 수 있습니다.responseContainer = "List"아래와 같이:

@ApiOperation(value = "retrieve items", response = Item.class, responseContainer = "List")

언급URL : https://stackoverflow.com/questions/54805169/set-list-of-objects-in-swagger-api-response