字段废弃

GraphQL 模式的版本控制涉及废弃字段，即告知用户该字段不应再使用，以及应使用哪个字段替代它。

除了通过代码废弃字段外，Gato GraphQL 还提供了一个用户界面，用于配置要废弃哪些字段以及如何废弃。

配置通过字段废弃列表创建，并通过模式配置提供给自定义端点和持久化 Query。

​

访问所有字段废弃列表

点击插件菜单中的「Field Deprecation Lists」，将显示所有已创建的字段废弃列表：

​

创建新的字段废弃列表

点击「Add New Field Deprecation List」按钮，打开 WordPress 编辑器：

为字段废弃列表添加标题，添加包含字段的条目，并配置废弃消息。准备好后，点击 Publish 按钮。新的字段废弃列表即可在模式配置中使用。

该字段将在模式中被标记为已废弃，此外，查询已废弃字段时，响应中将显示废弃消息（若模块 Deprecation Notifier 已启用）。

​

字段废弃条目

每个 Field Deprecation List 包含一个或多个条目，每个条目具有以下元素：

• 要废弃的字段
• 废弃消息

​

从接口选择字段

除了从类型中选择字段外，还可以从接口中选择字段。在这种情况下，废弃将对实现该接口的所有类型的这些字段执行。

​

描述字段废弃列表

使用 Document settings 面板中的「Excerpt」字段，为字段废弃列表添加描述。

详情请参阅指南 为 API 添加描述。

​

使用字段废弃列表

创建字段废弃列表后，可通过编辑对应的模式配置，让自定义端点或持久化 Query 使用它，并在「Field Deprecation Lists」块下的列表中选择相应的 ACL。

如果不自定义配置，将使用设置页面「Field Deprecation」标签下定义的默认 Field Deprecation Lists：