GraphQL API는 RESTful API와 다릅니다. 참조 정보는 GraphQL API 리소스 페이지에서 자동으로 생성됩니다.

그러나 다양한 사용 사례에 대해 GraphQL을 어떻게 사용하는지 예제를 포함하는 것이 도움이 됩니다. 독자들이 GraphiQL이라고 불리는 GraphQL 탐색기에서 직접 사용할 수 있는 샘플을 제공하세요.

이 섹션에서는 GitLab 문서에 GraphQL 예제를 추가하는 데 필요한 단계를 설명합니다.

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: List branch rules for a project by using GraphQL
---

이 내용을 사용 사례에 맞게 수정하는 데 도움이 필요하면 기술 문서 작성자에게 문의하세요.

내용 추가하기#

이제 본문 텍스트를 추가하세요. 다음 내용을 시작점으로 사용하고 텍스트를 자신의 정보로 교체할 수 있습니다.

You can query for branch rules in a given project by using:

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

## Use GraphiQL

You can use GraphiQL to list the branch rules for a project.

1. Open GraphiQL:
   - For GitLab.com, use: `https://gitlab.com/-/graphql-explorer`
   - For GitLab Self-Managed, use: `https://gitlab.example.com/-/graphql-explorer`
1. Copy the following text and paste it in the left window.

   <graphql codeblock here>

1. Select **Play**.

## Related topics:

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

글로벌 네비게이션에 GraphQL 예제 추가하기#

문서 웹사이트의 왼쪽에 있는 목록인 글로벌 네비게이션에 새 문서에 대한 링크를 포함하세요. 이를 위해 GitLab 문서 리포지터리에 대한 두 번째 머지 리퀘스트를 여세요.

글로벌 네비게이션은 content/data/en-us 하위 디렉터리의 navigation.yaml 파일에 설정되어 있습니다. GraphQL 섹션은 다음 줄 아래에서 찾을 수 있습니다:

- title: GraphQL

두 번째 머지 리퀘스트에 대한 CI 테스트는 새 GraphQL 페이지를 추가하는 메인 머지 리퀘스트가 병합될 때까지 잘못된 링크로 인해 실패한다는 점에 유의하세요. 따라서 콘텐츠가 병합되어 docs.gitlab.com에 라이브로 게시된 후에만 docs-gitlab-com 리포지터리에 대한 머지 리퀘스트를 병합하세요.