GraphQL

• 特点
  • 面向终端
  • 接口数据格式由客户端定义
  • 强类型
• GraphQL 规范
  • October2016
• Wikipedia GraphQLWikipediaGraphQL
• 实现
  • graphql/graphql-jsGitHubgraphql/graphql-js
    • A reference implementation of GraphQL for JavaScript
  • graphql-java/graphql-javaGitHubgraphql-java/graphql-java
    • GraphQL Java implementation
  • neelance/graphql-goGitHubneelance/graphql-go
    • GraphQL server with a focus on ease of use
    • 强类型, 基于反射
    • 直接基于 schema 解析
  • vektah/gqlgenGitHubvektah/gqlgen
    • go generate based graphql server library
    • HNHacker NewsHacker News #16352611Hacker News
  • graphql-go/graphqlGitHubgraphql-go/graphqlgraphql-go/graphql 是什么？ · Golang GraphQL 解析、执行库 · Code First - 先 Go 代码，然后生成 GraphQL · 通过 struct 构建内容生成 graphql schema · 通过 struct 构建 resolver 和类型字段处理笔记：graphql
    • An implementation of GraphQL for Go / Golang
    • 弱类型, Resolver 返回 interface{}
    • 解析的 schema 不能转为代码中的对象
  • graphql-python/grapheneGitHubgraphql-python/graphene
    • GraphQL framework for Python
    • graphene-python.org
  • graphql-js/grapheneGitHubgraphql-js/graphene
    • graphene-js.org
• 工具
  • postgraphql/postgraphqlGitHubpostgraphql/postgraphql
    • A GraphQL API created by reflection over a PostgreSQL schema.
  • 2fd/graphdocGitHub2fd/graphdoc
  • apollographql/graphql-syntaxGitHubapollographql/graphql-syntax
    • A catalog of different packages and syntaxes to generate a GraphQL-JS schema
  • graphql/graphiqlGitHubgraphql/graphiqlgraphql/graphiql · Explorer · Demo · adopted by · Hasura · Gitlab GraphQL Explorer · GitHub GraphQL Explorer · https://github.com/graphql/graphiql/blob/main/examples/graphiql-cd...笔记：GraphiQL
    • An in-browser IDE for exploring GraphQL
  • google/rejoinerGitHubgoogle/rejoiner
    • HNHacker NewsHacker News #16193250Hacker News
• 接口参考
  • Facebook Graph API
  • GitHubGraphQL API v4
    • 接口地址 api.github.com/graphqlLinkapi.github.com/graphql主要让 consumer/client 方使用便捷 · 核心特性/卖点 - 推荐开启 · GlobalID - ID 包含类型消息，能实现 ID -> · Graph Cache - 以 + id 来缓存 - 类似一个内存的 KV 数据库，可以直接查询笔记：GraphQL
    • github 文档
  • shopify 文档
    • explorer
  • graphcms.com/docs/api_simple
• 参考
  • Improve GraphQL Performance with Automatic Persisted Queries
    • 优化查询大小
    • 使用一个 Hash 值作为查询标识
  • The future of state management
    • 使用 GraphQL 来管理应用状态
  • GraphQL.g4GitHub Fileantlr/grammars-v4/graphql/GraphQL.g4
    • 语法参考
  • Designing GraphQL Mutations
    • 设计修改操作
  • GraphQL schema stitching
    • 合并多个 Schema
  • A guide to authentication in GraphQL
    • 认证
    • 识别用户身份
  • Authorization in GraphQL
    • 鉴权
    • 判断用户是否进行相关操作
  • Reusable GraphQL schema directives
  • Principled GraphQL
• Relay
  • facebook/relay
  • Learn Relay
  • What is a Query?
    • The node and viewer fields
• Pagination
  • 直接返回数组
  • 返回数组接收翻页参数
  • 返回链接
    • collections(first: Int!, after: String, reverse: Boolean): CollectionConnection!
    • followers(first: Int, after: String, last: Int, before: String): FollowerConnection!
• 客户端
  • Apollo React
  • prisma-labs/graphql-requestGitHubprisma-labs/graphql-request
    • 非常简单的客户端 - 配合 react-query 使用
    • react-query vs apollo client

# 获取 Schema
npm install -g graphqurl
gq https://my-graphql-engine.com/v1/graphql --introspect > schema.graphql
gq https://my-graphql-engine.com/v1/graphql -H 'X-Hasura-Admin-Secret: adminsecretkey' --introspect > schema.graphql
gq https://my-graphql-engine.com/v1/graphql --introspect --format json > schema.json

# https://github.com/apollographql/apollo-tooling
# schema.json
npm install -g apollo
apollo schema:download --endpoint https://my-graphql-engine.com/v1/graphql
apollo schema:download --endpoint https://my-graphql-engine.com/v1/graphql --header 'X-Hasura-Admin-Secret: adminsecretkey'

Packagesgraphqurlnpm PackagegraphqurlNPMapollonpm PackageapolloNPM

Apollo

• apollographqlGitHub Orgapollographql

FAQ

N + 1

• Avoiding n+1 requests in GraphQL, including within subscriptions

DateTime

• graphql/graphql-js#550GitHub Issuegraphql/graphql-js#550

vs REST

• You Might Not Need GraphQL
• GraphQL vs REST: Overview

TBD

graphql.org/code

skevy/graphiql-appGitHubskevy/graphiql-app Light, Electron-based Wrapper around GraphiQL

apollographql/apollo-serverGitHubapollographql/apollo-server

graphcool/graphql-playgroundGitHubgraphcool/graphql-playground GraphQL IDE for better development workflows (GraphQL Subscriptions, interactive docs & collaboration)

docker run -p 5000

chentsulin/awesome-graphqlGitHubchentsulin/awesome-graphql Awesome list of GraphQL & Relay

www.graphql.com graphql.org/learn/best-practices GraphQL Best Practices

www.apollographql.com Apollo provides a universal GraphQL API on top of your existing services, so you can build new application features fast without waiting on backend changes.

facebook/dataloaderGitHubfacebook/dataloader DataLoader is a generic utility to be used as part of your application's data fetching layer to provide a consistent API over various backends and reduce requests to those backends via batching and caching.

blog.datank.ai/graphql-grpc-part-1-54d92a109619 GraphQL & gRPC

relay

• GraphQL Cursor Connections Specification
• Pagination

global id

• docs.github.com/cn/graphql/guides/using-global-node-ids
  • github ID 格式 - 04:User583231
  • New global ID format coming to GraphQL
• 支持用于接口处理 - labelableId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "Labelable")
• Global Object Identification
• graphile/global-idsGitHubgraphile/global-ids