개발/Spring

[Swagger] Request가 Map인 경우 Controller 작성법

희묭 2023. 11. 1. 17:11

일반적으로 Controller 에 Request를 Vo로 받는것이 권장되지만

부득이하게 Map으로 받아야되는경우 아래와같이 Swagger를 작성할수 있습니다

@Tag(name = "테스트")
@Operation(parameters = {
    @Parameter(name = "test1", description = "테스트1", required = true, example = "1"),
    @Parameter(name = "test2", description = "테스트2", required = true, example = "2")
})
@PostMapping("/api/test")
HashMap<String, Object> test (@RequestParam HashMap<String, Object> param){
    return null;
}

 

 

Parameter hidden 처리를 안해주면 예제 prop가 나타납니다

그대로 놔둬도 상관없지만 혼란방지를 위해 hidden 처리를 해줍니다