Как настроить значения примера в Swagger 2 Springfox для тела запроса JSONObject? - PullRequest
Новая
       57

Как настроить значения примера в Swagger 2 Springfox для тела запроса JSONObject?

0 голосов
/ 18 февраля 2019

Я хотел бы настроить значения примеров для моей документации API, которую я делаю с помощью Swagger Springfox (Spring REST API). enter image description here

Поскольку тело запроса является строковым JSONчерез JQuery AJAX @RequestParam - это строка.Я пробовал несколько «решений», включая @ApiModel и @ApiImplicitParams, но все они не работали.Кажется, что "string" никогда не меняется.

Как изменить значения примера?Я не против, если это нужно сделать вручную.Я просто хочу, чтобы область показывала объект JSON.

1 Ответ

0 голосов
/ 24 апреля 2019

Если вы используете объект для описания тела запроса, вы можете использовать @ApiModelProperty, пример: 

data class RequestBody(
    @ApiModelProperty(example = "John Doe")
    val name: String,
    @ApiModelProperty(example = "Coolstreet 1")
    val address: String
)

Альтернативой является использование @Example и @ExampleProperties, но я нахожу их гораздо более беспорядочными,Вот несколько примеров того, как их использовать в официальном справочном документе: http://springfox.github.io/springfox/docs/current/#example-application

Приведенный пример: 

@RequestMapping(value = "/2031", method = RequestMethod.POST)
@ResponseBody
@ApiOperation(value = "/2031")
@ApiImplicitParams({
    @ApiImplicitParam(
        name = "contents",
        dataType = "CustomTypeFor2031",
        examples = @io.swagger.annotations.Example(
            value = {
                @ExampleProperty(value = "{'property': 'test'}", mediaType = "application/json")
            })) 
})
public void save(@PathVariable("keyId") String keyId,
                 @PathVariable("id") String id,
                 @RequestBody String contents 
) {
}

public static class CustomTypeFor2031 { 
  private String property;

  public String getProperty() {
    return property;
  }

  public void setProperty(String property) {
    this.property = property;
  }
}
...