由于不知道如何获取GitHub GraphQL API v4的schema.json文件，所以做了一份备忘录

3 年 ago
文, 翔
1 minute

提要

我认为大多数使用Android的应用程序在向采用GraphQL的API发送请求时使用了Apollo GraphQL Client for Android。

Apollo会根据在.graphql文件中定义的查询生成用于请求处理的代码。在这个过程中，还需要一个名为schema.json的GraphQL模式定义文件。

获取 GitHub GraphQL API v4 的 schema.json。

在Android项目的官方文档中所介绍的方法无法直接执行。据说apollo-codegen已经整合到apollographql/apollo-tooling中，并且使用方法有所改变。

使用Apollo CLI获取schema.json

安装 Apollo CLI，并使用apollo service:download命令替代apollo-codegen。

首先，使用npm安装命令行界面（CLI）。

$ npm install -g apollo

然后执行apollo service:download命令。使用–endpoint选项指定GraphQL终点，并使用–header选项添加授权信息。可以从GitHub的设置页面的开发者设置中获取个人访问令牌。

获取 GitHub GraphQL API v4 的 schema.json 文件的命令如下：

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

执行

只要显示如下内容即可。

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

请参阅此链接以获取有关可以通过 Apollo 服务: download 来指定的选项的详细信息。

请查阅资料。
请参考资料。

    • https://www.apollographql.com/docs/android/essentials/get-started.html

 

    • https://github.com/apollographql/apollo-tooling

 

    https://github.com/apollographql/apollo-android
bannerAds