このページでは、ワークスペースに取り込んだコンテンツを GraphQL API で取得する手順を説明します。
ワークスペース詳細ページの「概要」タブに API エンドポイントが表示されています。
https://api.hackersheet.com/example/v1/graphqlAPI エンドポイントへのリクエストには、ワークスペースアクセスキーが必要です。
アクセスキーは hsws_ から始まる文字列です。
API エンドポイントとアクセスキーを使って、GraphQL API でコンテンツを取得できます。以下は curl でドキュメント一覧を取得する例です。
curl -X POST https://api.hackersheet.com/example/v1/graphql \
-H "Content-Type: application/json" \
-H "Authorization: Bearer hsws_XXXXXXX" \
-d '{"query": "{ documents { nodes { title slug } } }"}'https://api.hackersheet.com/example/v1/graphql と hsws_XXXXXXX は、ワークスペース詳細ページで確認した値に置き換えてください。
このクエリを実行すると、ワークスペースに取り込まれたドキュメントの一覧(タイトルと Slug)が返されます。
Altair GraphQL Client などの GraphQL クライアントを使うと、API のスキーマ情報を確認できます。インストール方法を参考にセットアップし、API エンドポイントとアクセスキー(Authorization: Bearer hsws_XXXXXXX)をヘッダーに設定すると、利用可能なクエリやフィールドの一覧を参照できます。
GraphQL API でコンテンツを取得できることを確認できました。アプリケーションに組み込む場合は、npm パッケージの利用を検討してください。