添加 GraphQL schema
schema.graphql
自动填充 GraphQL 页面
docs.json 中的某个 tab 或 group 添加 graphql 属性。Mintlify 会解析 schema,并为每个操作和命名类型创建一个页面。
graphql 属性可接受字符串 (本地路径或 HTTPS URL) ,或包含以下字段的对象:
string
必填
指向文档仓库中 SDL 文件的本地路径,或指向已托管 SDL 文件的 HTTPS URL。不接受 HTTP URL。
string
生成页面所存放的目录。默认值为
graphql-reference。生成的页面
- Queries — 为
Query根类型的每个字段生成一个页面。 - Mutations — 为
Mutation根类型的每个字段生成一个页面。 - Types — 为每个命名的 object、input、enum、interface 或 union 类型生成一个页面。
选择特定的操作和类型
graphql 的 group 的 pages 数组中列出选择器。你也可以在声明了 graphql 的 tab 或 group 下嵌套的任意 group 中列出它们。声明了 graphql 的 tab 不能包含 pages,因此请将选择器放在该 tab 内的 group 中。Mintlify 只会为每个选中的操作或类型生成页面。
QUERY <field>:Query根类型上的字段。MUTATION <field>:Mutation根类型上的字段。TYPE <name>:具名的 object、input、enum、interface 或 union 类型。
MUTATION cart.createCart)来选择嵌套在命名空间字段下的操作。TYPE 选择器不支持点分路径。
侧边栏使用嵌套操作的最后一段作为标签,因此 MUTATION cart.createCart 显示为 createCart。页面 URL 保留完整路径,并以 cart/createCart 结尾。
如果声明了 graphql 的 tab 或 group 下有任何页面是选择器,Mintlify 会跳过为其生成完整的 Queries、Mutations 和 Types 部分。同一 pages 数组中的普通页面路径照常生效。
在精选参考中,query 和 mutation 页面只会链接到由你的选择器生成的类型页面。要链接某个已选操作所引用的类型,请为该类型添加一个 TYPE 选择器。
如果选择器在你的 schema 中没有匹配项,构建会失败,并报错指出缺失的操作或类型。
弃用
@deprecated 的字段和参数,会在生成的页面上被标记为已弃用。如果提供了弃用原因,将显示在该字段旁边。
更新你的文档
mint dev 或将更改推送到文档仓库时,Mintlify 会重新生成 GraphQL 参考页面。如果你的 schema 托管在 HTTPS URL 上,schema 的更新会在下一次构建时被采纳。