Help us learn about your current experience with the documentation. Take the survey.

创建 GraphQL 示例页面

GraphQL API 与 RESTful API 不同。参考信息在我们的 GraphQL API 资源页面中生成。

但是，包含如何使用 GraphQL 处理不同用例的示例会很有帮助，读者可以直接在名为 GraphiQL 的 GraphQL 探索器中使用这些示例。

本节介绍了将 GraphQL 示例添加到 GitLab 文档所需的步骤。

有关将资源添加到 GraphQL API 资源页面的信息，请参阅描述风格指南。

添加专用的 GraphQL 页面

要创建专用的 GraphQL 页面，请在 doc/api/graphql/ 目录中创建一个新的 .md 文件。为文件赋予一个功能性的名称，例如 import_from_specific_location.md。

添加元数据

在页面顶部添加描述性内容和标题，例如：

---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: 使用 GraphQL 列出项目的分支规则
---

{{< details >}}

- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

如需帮助编辑此内容以适应您的用例，请咨询技术写作人员。

添加内容

现在添加正文文本。您可以使用此内容作为起点，并用您自己的信息替换文本。

您可以使用以下方式查询给定项目的分支规则：

- GraphiQL。
- [`cURL`](getting_started.md#command-line)。

## 使用 GraphiQL

您可以使用 GraphiQL 列出项目的分支规则。

1. 打开 GraphiQL：
   - 对于 GitLab.com，使用：`https://gitlab.com/-/graphql-explorer`
   - 对于 GitLab Self-Managed，使用：`https://gitlab.example.com/-/graphql-explorer`
1. 复制以下文本并将其粘贴到左侧窗口中。

   <graphql codeblock here>

1. 选择 **Play**。

## 相关主题：

- [GraphQL API 参考](reference/_index.md)

将 GraphQL 示例添加到全局导航

在全局导航（文档网站左侧的列表）中包含指向您新文档的链接。为此，请针对 GitLab 文档仓库打开第二个 MR。

全局导航设置在 content/data/en-us 子目录中的 navigation.yaml 文件中。您可以在以下行下找到 GraphQL 部分：

- title: GraphQL

请注意，在添加新 GraphQL 页面的主 MR 合并之前，该第二个 MR 的 CI 测试将因链接错误而失败。因此，只有在内容已合并并在 docs.gitlab.com 上线后，才能合并针对 docs-gitlab-com 仓库的 MR。