LoginSignup
6
5

More than 5 years have passed since last update.

GitHub GraphQL API v4のschema.jsonファイルの取得方法がわからなかったのでメモ

Last updated at Posted at 2019-01-16

概要

AndroidでGraphQLを採用したAPIへのリクエストにApollo GraphQL Client for Androidを利用する場合が多いと思います。

Apolloでは、.graphqlファイルで定義したクエリからリクエスト処理で使用するコードを生成します。この時、schema.jsonと呼ばれるGraphQLのスキーマ定義ファイルが必要になります。

GitHub GraphQL API v4のschema.jsonの取得

Androidプロジェクト向けの公式ドキュメントで解説されている方法がそのままでは実行できませんでした。apollo-codegenapollographql/apollo-toolingに統合されたようで使い方が変わっています。

Apollo CLIを使用したschema.jsonの取得

Apollo CLIをインストールし、apollo-codegenの代わりにapollo service:downloadコマンドを使用します。

まずnpmでCLIをインストールします。

$ npm install -g apollo

そしてapollo service:downloadを実行します。--endpointオプションでgraphqlエンドポイントを指定し、--headerオプションで認可情報を追加します。GitHubのPersonalアクセストークンは、SettingsのDeveloper settingsから取得しましょう。

GitHub GraphQL API v4のschema.jsonファイルの取得は、次のようなコマンドになります。

$ apollo service:download --endpoint https://api.github.com/graphql \
  --header "Authorization: Bearer <GitHub personal access tokens>"

実行

以下のように表示されればOKです。

$ apollo service:download --endpoint https://api.github.com/graphql \
--header "Authorization: <GitHub personal access tokens>"
  ✔ Loading Apollo Project
  ✔ Saving schema to schema.json

apollo service:downloadで指定できるオプションの詳細はこちらをご覧ください。

参考資料

6
5
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
6
5