文章原文请移步我的博客:GraphQL 接口设计
graphql 是一种用于 API 的查询语言。它提供了一套完整的和易于理解的 API 接口数据描述,给客户端权力去精准查询他们需要的数据,而不用再去实现其他更多的代码,使 API 接口开发变得更简单高效。
最近在用Gatsby开发一版静态博客,感觉和这个框架真是相见恨晚。因为这个框架使用到了graphql技术,所以我花了点时间去学习了一下,并且记录了一下学习和思考过程。
本文主要讲解如何理解graphql以及基于关系型数据库设计graphql的思路。如果需要学习graphql基础知识,请移步官方文档
理解graphql
graphql是一个用于描述数据及其关系的查询语言,官方文档中描述了graphql的标准,具体的实现依靠第三方,目前主流的是Apollo提供的解决方案。
graphql并不关心具体我们是怎么获取数据的,我们只需要提供获取数据的方法(resolver)以及如何组装数据(schema)。类似于Java开发过程中的接口设计模式,Graphql定义了一套标准,我们按照标准实现接口。下面以用户-角色模型举例。
下面的代码定义了两个数据结构,与JSON类似,应该很容易理解。它描述了每个类型(type)的名称,以及其包含的属性。属性除了可以是基本类型外,也可以是数组、其他引用类型,从而建立起所有数据模型及相互的关系图。
type Role {
name: String
note: String
}
type User {
id: Int
name: String
gender: Int
role: Role
}
上面代码用于描述Role和User的数据结构,那么我们具体要怎么使用这个东西呢?先从前端的角度来看,可以从官方文档学习到前端的基本使用,请求体中的数据描述和上面定义类型的代码有些许差别,比如我们要查询用户数据:
query userInfo {
user(id: Int) {
id
name
gender
role {
name
note
}
}
}
从上面的代码可以大概猜测出,如果我们不需要查询role数据是,只需要将其从请求中去掉
query userInfo {
user(id: Int) {
id
name
gender
}
}
当请求到达服务端时,graphql会对请求体进行解析ÿ