Как изменить примерные значения для запросов api в пользовательском интерфейсе Swagger?

Я делаю API для сайта и использую пользовательский интерфейс Swagger. В настоящее время у меня есть маршрут для добавления избранного для пользователя, маршрут - "/users/{id}/favorites/", а параметры в спецификации:

        "parameters":[
          {
            "in":"path",
            "name":"id",
            "description":"User's Id",
            "required":true,
            "schema":{
              "$ref":"#/definitions/User"
            }
          },
          {
            "in":"body",
            "name":"body",
            "description":"Enter user's id and video id for favorite",
            "required":true,
            "schema":{
              "$ref":"#/definitions/Favorite"
            }
          }
        ],

Определение избранной модели в спецификации выглядит так:

"Favorite":{
  "type":"object",
  "properties":{
    "id":{
      "type":"integer",
      "format": "int64"
    },
    "userId":{
      "$ref":"#/definitions/User/properties/id"
    },
    "videoId":{
      "$ref":"#/definitions/Video/properties/id"
    }
  },
  "xml":{
    "name":"Flag"
  }
}

Но в настоящее время, когда я иду по маршруту /api, пример значения, показываемого для параметра body, равен

{
  "id": 0
}

в документации он правильно отображает почти правильный образец запроса и показывает:

{
  "id": 0,
  "userId": 0,
  "videoId": 0
}

Как изменить примерное значение для маршрута /api, чтобы показать

{
  "userId": 0,
  "videoId": 0
}

в качестве примера и как мне удалить параметр id из примера в документе


person jmona789    schedule 05.10.2016    source источник


Ответы (1)


Нашел способ сделать это, не уверен, что это лучший способ, но я просто изменил определение и сделал userId int вместо $ ref и то же самое для videoId.

person jmona789    schedule 28.11.2016