在 RESTful API 中使用 GraphQL——GraphQL Gateway-JavaScript中文网-JavaScript教程资源分享门户

什么是RESTful API

RESTful API（Representational State Transfer，表征性状态转移）是一种基于HTTP协议的Web API设计风格，包含四种HTTP请求方式（GET, POST, PUT, DELETE），每种 HTTP 方法对应着资源的不同操作。RESTful API设计风格的最大特点是，通过HTTP的请求方法来与资源进行交互，具有可阅读性和易于理解性的优点。

什么是GraphQL

GraphQL是一种由Facebook开发的数据查询语言，它可以用于客户端和服务器端之间的数据查询和操作。GraphQL的最大特点是它可以让客户端精确获取所需的数据，而不必返回整个数据模型。

GraphQL Gateway是什么

GraphQL Gateway是一个用于连接RESTful API和GraphQL的中间件。它可以将RESTful API中的数据模型映射到GraphQL的数据模型上，以便客户端使用GraphQL查询数据。GraphQL Gateway不需要修改现有的RESTful API代码，只需定义静态的映射关系即可。

GraphQL Gateway的优点

GraphQL Gateway有以下优点：

简化客户端与服务器端之间的数据交互。客户端不需要单独发起不同的请求获取数据，只需要发送GraphQL查询，服务器端返回GraphQL格式的数据；
可以更加精确地获取所需的数据。GraphQL Gateway可以通过映射RESTful API中的数据模型，快速向客户端提供GraphQL数据模型，减少不必要的传输和计算；
保留已有的RESTful API接口。GraphQL Gateway不需要修改现有的RESTful API代码，只需定义映射关系即可；
支持多种数据源。GraphQL Gateway可以连接多种数据源，包括但不限于RESTful API、MySQL、Redis等，提供更多数据查询方式。

GraphQL Gateway的示例代码

下面是一个使用GraphQL Gateway的示例代码：

// javascriptcn.com 代码示例
const { ApolloServer } = require('apollo-server')
const { RESTDataSource } = require('apollo-datasource-rest')
const { GraphQLGateway } = require('@supabase/gotrue-node')
const typeDefs = require('./typeDefs')
const resolvers = require('./resolvers')

const gateway = new GraphQLGateway({
  name: 'my-gateway',
  routes: [
    {
      name: 'blog',
      url: 'http://localhost:3001',
    }
  ]
})

class BlogAPI extends RESTDataSource {
  constructor() {
    super()
    this.baseURL = 'http://localhost:3001'
  }

  async getArticle(id) {
    return this.get(`/articles/${id}`)
  }
}

const server = new ApolloServer({
  gateway,
  engine: false,
  dataSources: () => ({
    blogAPI: new BlogAPI(),
  }),
  typeDefs,
  resolvers,
})

server.listen().then(({ url }) => {
  console.log(`Server ready at ${url}`)
})

这段代码利用了GraphQL Gateway连接了一个本地的RESTful API，然后通过RESTDataSource对象定义了一个数据源类BlogAPI，从而可以通过GraphQL对该API进行数据查询。

总结

GraphQL Gateway是一个非常实用的中间件，它可以让我们在不改变原有RESTful API代码的情况下，只需定义简单的映射关系，就能够让客户端使用GraphQL查询数据。GraphQL Gateway简化了客户端与服务器端之间的数据交互，提高了数据查询的效率，是前端开发中不可缺少的工具。

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/653360067d4982a6eb6e6b65