GraphQL APIを操作する準備をして、最初のクエリを実行するまでの手順です。
アクセストークンを用意する
GraphQL APIを操作するにはアクセストークンが必要です。
発行のしかたはAnnict APIの認証を参照してください。
データを取得するだけであれば「読み込み専用」のスコープで足ります。
記録の投稿などGraphQL APIのミューテーションを実行する場合は「読み込み + 書き込み」が必要です。
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" } } }
GraphQLクライアントで実行する
GraphiQLやInsomniaなどのGraphQLクライアントからも実行できます。
どのクライアントを使う場合でも、設定するのは次の2つです。
- エンドポイントに
https://api.annict.com/graphqlを指定する AuthorizationヘッダにBearer <アクセストークン>を指定する
Bearer Token用の入力欄を持つクライアントでは、ヘッダを直接書く代わりにその欄へアクセストークンを入力します。
設定できたら、次のクエリを実行してみてください。
自分のユーザー名と表示名が返ってくれば、準備は完了です。
query {
viewer {
username
name
}
}
スキーマを確認する
GraphQL APIが提供するクエリやミューテーションは、GraphQLクライアントから一覧できます。
スキーマの調べ方はGraphQL APIのリファレンスにまとめています。