草稿

在开启了发布的模型上,每次保存都会新增一个草稿版本,API 仍然返回已发布的版本。在发布之前,你可以看到 API 会如何提供该草稿。

保存做了什么

新记录从版本 1 开始,处于草稿状态。每次保存都会新增一个版本,公开 API 会继续返回已发布的版本,直到你按版本 id 发布某个具体版本。发布是按模型开启的。在没有开启发布的模型上,更改会立即生效。

记录编辑器中的预览窗格

控制台中的记录编辑器有一个预览窗格。它根据实时 schema 构建该记录的 GraphQL 查询,针对公开 API 运行并显示精确的响应。切换开关可以把同一次读取显示为 GraphQL 文档或 SDK 调用,另一个开关可以在已保存的草稿和最近一次发布的版本之间切换。语言区域来自编辑器的语言选择器,你还可以设置项目的上下文维度,并模拟登录状态和分群。

以某个特定密钥预览

窗格可以以你自己的控制台会话运行,也可以以收窄到所选作用域的该会话运行,或者以你粘贴进来的公开密钥运行。你自己的会话可以读取所有字段,因此要查看某个API 密钥会得到什么,请粘贴该密钥。

从你自己的应用读取草稿

传入 preview: true的查询会读取最新草稿,其密钥必须持有 drafts:read作用域。文档中的推荐做法是为预览部署使用单独的公开密钥,该密钥持有此作用域,而生产密钥没有。没有此作用域的密钥发出的预览请求,会因权限错误被拒绝。草稿读取绝不会存入响应缓存。

阅读详情

记录指南阐述了草稿和发布工作流,以及每一步对应的 GraphQL mutation 和 CLI 命令。