Как я могу описать пример ввода для java @RequestBody Map <String, String>?

Question

Я проектирую api, где один из методов POST, который принимает Map<String, String> любых пар значений ключа.

@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 
} 

Я хотел бы представить пример ввода для fields, но я не могу показаться, чтобы получить его, чтобы сделать на выходе развязность. Это неправильный способ использования @Example?

Answer 1

Пока объекты недвижимости @ExampleProperty и @Example уже представлены в Swagger, Springfox не поддерживает их. Вопрос остается открытым:

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