添加 GraphQL schema
schema.graphql
自动填充 GraphQL 页面
docs.json 中的某个 tab 添加 graphql 属性。Mintlify 会解析 schema,并为每个操作和命名类型创建一个页面。
graphql 属性可接受字符串 (本地路径或 HTTPS URL) ,或包含以下字段的对象:
string
必填
指向文档仓库中 SDL 文件的本地路径,或指向已托管 SDL 文件的 HTTPS URL。不接受 HTTP URL。
string
生成页面所存放的目录。默认值为
graphql-reference。GraphQL 源仅在 tab 上受支持。声明了
graphql 的 tab 不能同时声明 openapi 或 asyncapi。生成的页面
- Queries — 为
Query根类型的每个字段生成一个页面。 - Mutations — 为
Mutation根类型的每个字段生成一个页面。 - Types — 为每个命名的 object、input、enum、interface、union 或 scalar 类型生成一个页面。
弃用
@deprecated 的字段和参数,会在生成的页面上被标记为已弃用。如果提供了弃用原因,将显示在该字段旁边。
更新你的文档
mint dev 或将更改推送到文档仓库时,Mintlify 会重新生成 GraphQL 参考页面。如果你的 schema 托管在 HTTPS URL 上,schema 的更新会在下一次构建时被采纳。