创建 API创建 Schema 配置
创建 Schema 配置
Schema 配置用于为自定义端点和持久化 Query 定制 Schema。
GraphQL Schema 可以通过已安装并启用的各个模块所提供的元素进行配置。(请前往模块页面查看所有模块的列表。)
每个模块可以通过 Schema 配置编辑器中的专属区块来定义其配置。包括以下区块:
- 将 Schema 设置为公开或私有
- 启用"敏感"数据元素
- 为 Schema 添加命名空间
- 使用嵌套 Mutation
- 定义响应头
- 通过访问控制列表定义谁可以访问 Schema
- 通过缓存控制列表设置 HTTP 缓存
- 以及更多其他选项

访问所有 Schema 配置
点击插件菜单中的「Schema Configurations」,即可显示所有配置的列表:

创建新的 Schema 配置
点击「Add New Schema Configuration」按钮,打开 WordPress 编辑器:

删除使用"Default"值配置的区块(可选)
可以删除那些使用设置中对应「Default」值的配置区块。
已删除的区块可以通过点击底部的 + 按钮,从插入器菜单中重新添加(请注意每种区块只能插入一个实例):

然后为所需区块提供相应配置。
为 Schema 配置添加描述
使用文档设置面板中的「Excerpt」字段,为 Schema 配置添加描述。
更多信息请参阅指南 为 API 添加描述。
发布 Schema 配置
选择 Schema 配置所需的元素并调整选项。准备就绪后,点击「Publish」:

使用 Schema 配置
发布后,Schema 配置将在自定义端点和持久化 Query 的编辑器中可供选择:

查看 Schema 配置
在浏览器中打开 Schema 配置的固定链接,即可查看其内容(前提是用户已登录且用户角色具有访问权限):

Prev
Next