如何使用 Spring OpenAPI 3.0 忽略 Swagger 请求字段？

Question

我们有以下Token架构，而 scmOrg 被定义为外键。

{
  id        integer($int64)
  scmOrg    ScmOrg{...}
  type      string
  rawToken  string
}

打开 Swagger 控制台时，它会像这样构建示例输入：

{
  "id": 0,
  "scmOrg": {
    "id": 0,
    "scm": {
      "id": 0,
      "name": "string",
      "baseUrl": "string",
      "clientId": "string",
      "clientSecret": "string"
    },
    "name": "string",
    "team": "string"
  },
  "type": "string",
  "rawToken": "string"
}

只能为现有的scmOrg实体添加新令牌，所以我真正想要的是像这样更严格的东西：

{
  "id": 0,
  "scmOrg": {
    "id": 0
  },
  "type": "string",
  "rawToken": "string"
}

Swagger 有可能吗？

Answer 1

AFAIK 没有办法实现这一点。 事实上，您可以编辑模型以设置@ApiModelProperty(hidden = true) 。 但是，我反对这样做，此外，您在模型上所做的任何事情都将在下次重新生成时被覆盖。 检查此链接，它有点旧，但似乎 swagger 背后的人似乎在他们的路线图中没有这个。 https://community.smartbear.com/t5/Swagger-Open-Source-Tools/How-to-hide-Model-Information/mp/183188#M347