Logo
弃用
弃用Deprecation Notifier

Deprecation Notifier

Included in the “Power Extensions” bundle

在 Query 的响应中发送弃用通知（而不仅仅是在执行 introspection 时），位于顶层条目 extensions 下。

说明

每当查询了已弃用的字段时，弃用消息将在同一个 GraphQL 响应的顶层条目 extensions 中返回。

这会提醒 API 的用户升级其对 schema 的使用方式，即使他们并未关注 introspection query。

例如，运行以下 query，其中字段 isPublished 已被弃用：

query {
  posts {
    title
    isPublished
  }
}

...将产生如下响应：

{
  "extensions": {
    "deprecations": [
      {
        "message": "Use 'isStatus(status:published)' instead of 'isPublished'",
        "extensions": {
          ...
        }
      }
    ]
  },
  "data": {
    "posts": [
      ...
    ]
  }
}