Skip to main content

セットアップ

アクセストークンを用意する​

GraphQL APIを操作するにはアクセストークンが必要です。 アクセストークンについては認証の概要ページをご参照ください。

クエリの実行環境を用意する​

GraphQL APIは以下のような方法で操作することができます。

  • curl コマンド
  • GUIクライアント

GUIクライアントはGraphiQLやInsomniaなどがあります。 このページではInsomniaを使用します。

クエリを実行する​

curlコマンドで実行する​

curl コマンドを使用して実行する場合は以下のようなオプションを付加します。

$ curl https://api.annict.com/graphql \
-H "Authorization: bearer <アクセストークン>" \
-X POST \
-d "query=query { viewer { name } }"

query パラメータに query { viewer { name } } というクエリを付加してPOSTリクエストを送っています。 上記コマンドを実行すると下記のようなJSONデータが返ります。

{"data":{"viewer":{"name":"Koji Shimba"}}}

Insomniaで実行する​

Insomniaを立ち上げると下の画像ようなウィンドウが表示されます。

image

左のカラムにある追加ボタンをクリックし、 GraphQL Request をクリックします。

image

下記エンドポイントを入力します。

https://api.annict.com/graphql

image

GraphQL APIにリクエストを投げるとき、エンドポイントは常にこのURLになります。

次にアクセストークンをヘッダに登録します。 Auth タブをクリックし、Bearer Token をクリックします。

image

TOKEN 欄にアクセストークンを指定します。

以上でGraphQL APIを操作するための設定が終わりました。GraphQL タブをクリックし、以下のクエリを書いてみます。

query {
  viewer {
    username
    name
  }
}

image

クエリを入力したあと、Send ボタンをクリックすると、右側に取得結果が表示されます。

image

スキーマを確認する​

GraphQL APIが提供するクエリやミューテーションなどはGraphQLクライアントから閲覧することができます。 Insomniaで閲覧する方法についてはInsomniaのドキュメントをご参照ください。