如何在 Swagger UI 中更改 api 请求的示例值？

Question

我正在为网站制作一个 API，并且我正在使用 Swagger UI，我目前有一个为用户添加收藏的路线，路线是 "/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 参数

Answer 1

找到了一种方法，不确定这是否是最好的方法，但我只是更改了定义并将 userId 设为 int 而不是 $ref，videoId 也是如此。

如何在 Swagger UI 中更改 api 请求的示例值？

How to change the example values for api requests in Swagger UI?

api

swagger

swagger-ui