ワークスペースはドキュメントやアセットを一つにまとめる機能です。一つのワークスペースは一つのコンテンツリポジトリと連携してファイルを取り込みます。
ダッシュボードのサイドメニューからワークスペースの詳細ページを開くことができます。
ダッシュボードの「ホーム」ページを開きます。
「ワークスペース作成」ボタンから作成フォームを開きます。
各項目を入力します。
| 項目 | 説明 |
|---|---|
| 名前 | 管理用の名前です |
| Slug | APIエンドポイントのURLに使用される識別子です |
| 連携リポジトリ | 連携するリポジトリコンテンツリポジトリを選択します |
「作成する」ボタンで作成します。
ワークスペースにファイルを取り込むためには、連携リポジトリを設定した状態でコンテンツリポジトリとして登録されたGitHubリポジトリに変更をプッシュします。
これ以外に「同期」という方法もあります。
ワークスペースの詳細ページにある「同期」ボタンから同期処理を開始できます。同期処理を行うことで、ワークスペースとGitHubリポジトリの内容を揃えることができます。
以下のような場合に利用します。
一つのワークスペースには一つのAPIエンドポイントが設定されています。ワークスペースの詳細ページの「概要」から確認できます。
https://api.hackersheet.com/example/v1/graphqlAPIエンドポイントに対してリクエストしてデータ取得するためには、ワークスペースアクセスキーをAuthorizationヘッダーに設定する必要があります。
Authorization: Bearer hsws_XXXXXXX のように設定してください。
ワークスペースアクセスキーはワークスペースの詳細ページの「概要」から確認できます。