how to describe the parameters of a hashmap in swagger v3?

Question

I need to customize the request body in swagger, because in my controller I get a HashMap<String, String> and in the documentation it appears as

I would like to inform which properties I want to receive in the hashmap and I don't know how to annotate.

My Controller

@PostMapping("/add")
@ResponseStatus(HttpStatus.CREATED)
public Atendimento create(@RequestBody HashMap<String, String> param) throws Exception {
    return service.create(param);
}

Well, if you need to see the model, just use it in the controller :) What's the motivation of using Hashmap ? — Ion Ionets, Jun 09 '22 at 07:59
i can't pull out the hashmap, i just need to say what properties i want to receive in it. — Rafael da Silva, Jun 10 '22 at 15:09

score 3 · Accepted Answer · answered Jun 16 '22 at 20:32

Maybe the following will help you, but still the same question stands why you are not using a model (DTO) class directly instead.

Here is an example using Kotlin, which can help you:

@RestController
class SampleController {

    data class RequestBodyMetaData(
        val key1: String,
        val key2: String,
        val key3: String,
    )

    @PostMapping("/sample")
    fun sample(
        @io.swagger.v3.oas.annotations.parameters.RequestBody(
            content = [
                Content(
                    schema = Schema(implementation = RequestBodyMetaData::class),
                )
            ]
        )
        @org.springframework.web.bind.annotation.RequestBody
        sample: Map<String, String>,
    ) {
    }
}

how to describe the parameters of a hashmap in swagger v3?

1 Answers1