如何使用SpringOpenAPI3.0忽略招摇过市请求字段？

Question

我们有以下令牌模式，而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"
}

有可能大摇大摆吗？

Answer 1

AFAIK没有办法实现这一点。事实上，您可以编辑您的模型来设置@ApiModelProperty（隐藏=true）。但是，我反对这样做，此外，无论你在模型上做什么，下次重新生成时都会被覆盖。看看这个链接，它有点旧，但似乎昂首阔步背后的人似乎没有这个在他们的路线图中。https://community.smartbear.com/t5/Swagger-Open-Source-Tools/How-to-hide-Model-Information/m-p/183188#M347