Jak mogę ręcznie opisać przykładowe wejście dla mapy java @RequestBody <String, String>?

Question

Projektuję api, gdzie jedna z metod POST, która pobiera Map<String, String> dowolnej pary wartości klucza.

@RequestMapping(value = "/start", method = RequestMethod.POST) 
public void startProcess(
    @ApiParam(examples = @Example(value = { 
     @ExampleProperty(
      mediaType="application/json", 
      value = "{\"userId\":\"1234\",\"userName\":\"JoshJ\"}" 
     ) 
    })) 
    @RequestBody(required = false) Map<String, String> fields) { 
    // .. does stuff 
} 

Chciałbym zapewnić wejście przykładem dla fields ale nie wydaje się uzyskać go do renderowania na wyjściu Swagger. Czy nie jest to właściwy sposób użycia @Example?

Answer 1

Chociaż właściwości @ExampleProperty i @Example są już zaimplementowane w Swagger, Springfox nie obsługuje ich (jeszcze). Sprawa jest nadal otwarta:

• https://github.com/springfox/springfox/issues/853
• https://github.com/springfox/springfox/issues/1536