GraphQLサンプルページの作成

GraphQL APIはRESTful APIとは異なります。参考情報はGraphQL APIリソースページで生成されます。

しかし、さまざまなユースケースでGraphQLを使用する方法について、読者がGraphiQLエクスプローラーで直接使用できるサンプルを含めて例を示すことは有益です。

このセクションでは、GraphQLの例をGitLabドキュメントに追加するために必要な手順を説明します。

専用の GraphQL ページを追加します。

専用のGraphQLページを作成するには、doc/api/graphql/ ディレクトリに新しい.md ファイルを作成します。そのファイルには、import_from_specific_location.md のような機能名を付けます。

ページを説明で開始します。

次のように、GraphQLの機能を一言で説明するページタイトルを含めます：

# Search for [substitute kind of data]

検索について説明してください。一文で十分かもしれません。より詳細な情報は、読者がGitLabのデプロイにサンプルを使う方法を学ぶのに役立つかもしれません。

GraphiQLエクスプローラーを使った手順を含める

GraphiQLエクスプローラーを使用すると、デプロイされたクエリをテストすることができます。セクションを次のように設定します：

  • 以下のタイトルを使用してください：

     ## Set up the GraphiQL explorer

  • 誰でもGraphiQLエクスプローラーのインスタンスに含めることができるクエリのコードブロックを含めます：

     ```graphql
 query {
   <insert queries here>
 }
 ```

  • ユーザーに何をすべきかを伝えます：

     1. Open the GraphiQL explorer tool in the following URL: `https://gitlab.com/-/graphql-explorer`.
 1. Paste the `query` listed above into the left window of your GraphiQL explorer tool.
 1. Select **Play** to get the result shown here:
  • GraphiQLエクスプローラーに結果のスクリーンショットを含めます。ドキュメント・スタイル・ガイドの画像の保存セクションに記載されている命名規則に従ってください。
  • 出力で何ができるかの例を追って説明してください。その例は、読者が自分のデプロイで実行できるものであることを確認してください。
  • GraphQL APIリソースへのリンクを含めてください。

グローバルナビゲーションにGraphQLの例を追加します。

グローバルナビゲーション（ドキュメントウェブサイトの左側にあるリスト）に新しいドキュメントへのリンクを追加する必要があります。そのためには、GitLabドキュメントリポジトリに対して2つ目のMRを開きます。

content/_data サブディレクトリのnavigation.yaml ファイルにグローバルナビゲーションを保存します。以下の行の下にGraphQLセクションがあります：

- category_title: GraphQL

新しいGraphQLページを追加するメインのMRがマージされるまで、2番目のMRのCIテストは不正なリンクで失敗することに注意してください。したがって、コンテンツがマージされ、docs.gitlab.com に反映された後、gitlab-docs リポジトリに対してのみ MR をマージしてください。