GraphQL 예제 페이지 작성하기

GitLab 문서에 GraphQL 사용 예제 페이지를 추가하는 방법과 글로벌 네비게이션 등록 절차를 설명합니다.

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 예제 추가하기 # 문서 웹사이트의 왼쪽에 있는 목록인 글로벌 네비게이션에 새 문서에 대한