编写graphql服务

graphql用一种高效清晰的规范来替代目前正流行的RESTful架构。通过灵活的结构化查询语言让查询更高效,静态类型和规范提升前后端联调效率。作为一名前端我非常喜欢graphql,梦想有一天以前所有零散又没有文档的接口都被graphql所代替,这将极大提升我的开发效率和开发体验。等待不如自己动手,下面将介绍如何编写一个基于hackernews API的graphql服务。

在编写前先体验已经做好的graphql服务demo

这个graphql服务和hackernews官方API类似,提供了获取文章和用户信息的接口。 在开发graphql服务前你可能需要知道graphql提供了哪些能力,以及graphql定义了哪些规范,这些都可以在这里学习

graphql服务核心概念

  • 类型(type):type是最基础的因为graphql服务返回数据一定是定义好的类型的单个或者数组。类型就像面对对象编程里的class,返回数据是class的实例
  • 字段(filed):filed组成type,一个type由多个filed构成。filed就像面对对象编程里的class的一个属性。每个字段都有返回类型,返回类型是定义的type
  • 查询(query):通过query来暴露graphql服务所提供的所有读接口,query就是type它由filed组成
  • 变化(mutation):通过mutation来暴露graphql服务所提供的写接口,mutation就是type它由filed组成

graphql服务由type和filed构成,type和filed相互依赖

由于type由filed构成,编写graphql服务的核心工作就是编写filed,如何获取数据和处理写操作的逻辑全来自于filed。

接下来将使用golang开始编写。

所有查询的入口(query):
var RootQuery = graphql.NewObject(graphql.ObjectConfig{
    Name:        "RootQuery",
    Description: `hackernews's API`,
    Fields: graphql.Fields{
        "story": &graphql.Field{
            Type:        storyType,
            Description: `get story item by story.id`,
            Args: graphql.FieldConfigArgument{
                "id": &graphql.ArgumentConfig{
                    Type:        graphql.NewNonNull(graphql.Int),
                    Description: "item's unique id",
                },
            },
            Resolve: func(p graphql.ResolveParams) (interface{}, error) {
                if id, ok := p.Args["id"].(int); ok {
                    return model.GetStory(int32(id))
                }
                return nil, nil
            },
        },
        "topstories": &graphql.Field{
            Type:        graphql.NewList(storyType),
            Description: `Up to 500 top stories`,
            Resolve: func(p graphql.ResolveParams) (interface{}, error) {
                ids := []int32{}
                model.GetKV("topstories", &ids)
                return model.GetStories(ids), nil
            },
        },
    },
})

以上代码暴露出了2个查询接口(也是2个字段)

  • story字段通过id获取一个story,该字段返回类型是storyType
  • topstories获取500个热门的story,该字段返回类型是[storyType]

可以看到获取数据的逻辑都在Resolve函数里,由于篇幅有限model 里封装的如何去数据库获取数据的代码忽略了。

storyType的代码
var storyType = graphql.NewObject(graphql.ObjectConfig{
    Name: "Story",
    Description: `Stories, They're identified by their ids, which are unique integers.
    All items have some of the following properties.
    `,
    Fields: graphql.Fields{
        "id":      idField,
        "by":      byField,
        "time":    timeField,
        "deleted": deletedField,
        "dead":    deadField,
        "text":    textField,
        "score":   scoreField,

        "url":         urlField,
        "title":       titleField,
        "descendants": descendantsField,

        "doc": docField,
        "comments": &graphql.Field{
            Name:        "comments",
            Description: `this poll's comments`,
            Type:        graphql.NewList(commentType),
            Resolve: func(p graphql.ResolveParams) (interface{}, error) {
                poll := p.Source.(*model.Poll)
                return model.GetComments(poll.Kids), nil
            },
        },
    },
})

这段代码定义了要返回的storyType是什么样的以及storyType的每个字段的数据是怎么获取的。以storyTypecomments字段为例Resolve: func里告诉了如何去获取这篇文章的所有评论。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 编写graphql服务

    graphql用一种高效清晰的规范来替代目前正流行的RESTful架构。通过灵活的结构化查询语言让查询更高效,静态类型和规范提升前后端联调效率。作为一名前端我非...

    IMWeb前端团队
  • 移动端重构实战系列1——基础知识

    距离上个移动端重构系列已是两年了(不得不感叹时间是把杀猪刀)。这次将会带来实战系列,将欠下两年的债现在还上,给七年的重构赋予一次新生。 既然是新的开始,先简单说...

    IMWeb前端团队
  • 移动端重构实战系列1——基础知识

    ”本系列教程为实战教程,是本人移动端重构经验及思想的一次总结,也是对sandal及sheral UI的一次全方位剖析,首发在imweb和w3cplus两大站点及...

    IMWeb前端团队
  • 编写graphql服务

    graphql用一种高效清晰的规范来替代目前正流行的RESTful架构。通过灵活的结构化查询语言让查询更高效,静态类型和规范提升前后端联调效率。作为一名前端我非...

    IMWeb前端团队
  • Go GraphQL 教程

    一般的 Web 开发都是使用 RESTful 风格进行API的开发,这种 RESTful 风格的 API 开发的一般流程是:

    谢伟
  • 【业界】Waymo与捷豹联合推出全球首款全自动驾驶电动汽车I-PACE

    AiTechYun 编辑:nanan ? 当地时间3月27日,谷歌旗下自动驾驶公司Waymo发布世界上第一款高级电动全自动驾驶汽车—I-PACE。 Waymo表...

    AiTechYun
  • LC1263-AI寻路优化: 距离优先bfs -> heuristic + A* -> tarjan + A*

    输入的地图的大小在 1 ~ 20,规模小,如果用dfs或bfs,并且每个点最多访问一次,则最多访问 400 个点

    执生
  • 威feng网站的aes算法破解

    话说这个网站在过年前使用了aes算法,当然过年后也是aes,但就是把秘钥换了,换成更需要解密一段字符串,然后获得秘钥,最后请求时候再去用这个秘钥加密,并且最后发...

    吾爱小白
  • 微信小程序列表项滑动显示删除按钮

    微信小程序并没有提供列表控件,所以也没有iOS上惯用的列表项左滑删除的功能,SO只能自己干了。 原理很简单,用2个层,上面的层显示正常的内容,下面的层显示一个删...

    kklldog
  • 微信小程序开发常见问题(七)

    知晓程序员,专注微信小程序开发的程序员! 一、判断小程序版本号 小程序的API是不断更新的,你可能使用某个API时,文档里会说明,此API在1.x.x版本开始...

    连胜

扫码关注云+社区

领取腾讯云代金券