使用 GraphQL 架构实现 Webhook API-JavaScript中文网-JavaScript教程资源分享门户

Webhook 是一种 API，用于在特定事件发生时向指定的 URL 发送 HTTP 请求。这种 API 在很多场景下非常有用，例如当您的应用程序需要与第三方服务进行集成或者实时更新数据时等。GraphQL 架构使得实现 Webhook 变得更加容易和优雅。

什么是 GraphQL？

GraphQL 是 Facebook 开源的一种数据查询和操作语言，其具有强大的查询功能并且允许客户端精确地指定所需的数据。GraphQL 架构特别适合前端应用程序，因为它提供了一种优雅的方式来与服务器进行交互。

GraphQL 通常以叫做“Schema”的模式作为服务的标准定义。Schema 包括了 API 所能够提供的类型、字段以及返回值。整个架构基于 Schema 构建，而客户端可以通过发送包含参数和查询的请求来获得想要的数据。

Webhook API 和 GraphQL 的结合

Webhook API 在某些方面与 GraphQL 架构非常相似。Webhook API 可以理解为一组异步请求，当特定事件发生时，调用 Webhook API 向指定 URL 发送 HTTP 请求。这意味着 Webhook API 也需要一种能够处理异步操作的机制。在 GraphQL 中执行异步操作的最佳方法是使用 subscriptions（订阅）。

GraphQL subscriptions 允许客户端监听服务器端的事件，并根据这些事件的发生实时地获取数据。这个特性非常适合 Webhook API，因为客户端可以通过监听特定事件来获取实时更新的数据。

在 GraphQL 中实现 Webhook API

GraphQL 中的 subscriptions 允许你在服务器端定义允许客户端订阅的事件。我们需要使用第三方库来将 Webhook 与 subscriptions 相结合。其中一个可用的库是 graphql-subscriptions。

以下是一个简单的 Webhook API 的代码示例：

// javascriptcn.com 代码示例
import { withFilter } from 'graphql-subscriptions';

const Subscription = new GraphQLObjectType({
    name: 'Webhook',
    fields: {
        data: {
            type: GraphQLString,
            resolve(rootValue) {
                return rootValue;
            }
        }
    },
    resolve: () => 'Data received by webhook',
    subscribe: withFilter(() => pubSub.asyncIterator('dataReceived'), (rootValue, args) => {
        return rootValue === args.data;
    })
});

const schema = new GraphQLSchema({
    query: new GraphQLObjectType({
        name: 'Query',
        fields: {
            webhook: {
                type: GraphQLString,
                resolve: root => 'Webhook API'
            }
        }
    }),
    subscription: Subscription
});

在上面的代码中，我们定义了一个 Subscription 类型，它允许客户端监听 dataReceived 事件。我们使用 pubSub.asyncIterator 来创建一个可以用作 subscription 的可迭代对象。我们还使用 withFilter 函数对可迭代对象进行过滤，以便客户端只会在数据满足特定条件时才会接收到更新。

在上面的例子中，客户端需要订阅的条件是 rootValue === args.data，也就是说只有当 rootValue 等于 args.data 时客户端才会接收到更新。这种条件可以根据需要定制，例如，我们可以添加一个额外的参数来指定事件类型等。

总结

GraphQL 的 subscriptions 功能提供了一种优雅方式来实现 Webhook API，而无需使用额外的库或者固定某种特定的格式。使用 GraphQL 架构实现 Webhook API，可以使我们以一种更加优雅和可拓展的方式进行服务开发。

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