Swagger 2 с Spring REST API - PullRequest
       37

Swagger 2 с Spring REST API

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

Я пытаюсь создать документацию для моего Sping REST API.У меня есть контроллер, который принимает в качестве входных данных в качестве параметра объект, подобный этому:

public class CommentoDto implements Serializable{

      private Long id;
      private String content;
      private UtenteDto utente;
      private VideoDto video;
      private String creationDate;
      //Getters and setters

, где UtenteDto и VideoDto являются ссылками на другие объекты моей модели данных. У меня есть аннотированное свойство со следующей аннотацией:

@ApiModelProperty(
        required = true, 
        value = "Content of comment", 
        example = "Hello world!")

Какое значение я могу определить для UtenteDto и VideoDto в правильной карте порядка в документации Swagger и дать правильное примерное значение для третьей части, которая будет вызывать мой API?Что мне нужно во что-то вроде этого:

  @ApiModelProperty(
            required = true, 
            value = "Video ", 
            example = "video: {'id':25})")
...