在 GraphQL 中使用 RestDataSource 连接 REST API 的技术实现

前言

REST API 和 GraphQL 都是常用的 Web API 的类型，两者各有优缺点。在一些场景下，需要在 GraphQL 中调用 REST API。然而，GraphQL 中没有自带的 REST API 连接方式。为了解决这个问题，我们可以使用 RestDataSource 作为 GraphQL 的数据源来连接 REST API。本文将详细介绍如何使用 RestDataSource 连接 REST API 的技术实现，并包含了示例代码供读者参考。

RestDataSource 是什么？

RestDataSource 是一个由 Apollo 提供的工具类，用于连接 REST API。它能方便地将 REST API 中的数据转换成 GraphQL 场景中使用的类型。

使用 RestDataSource 连接 REST API

在使用 RestDataSource 时，需要进行以下几个步骤：

1. 安装 RestDataSource

首先，需要安装 RestDataSource。可以使用 npm 进行安装：

$ npm install apollo-datasource-rest

2. 创建 RestDataSource 子类

接下来，需要创建一个继承自 RestDataSource 的子类。这个子类将连接 REST API 并定义 fetch 方法用于请求数据。

const { RESTDataSource } = require("apollo-datasource-rest");

class MyRestDataSource extends RESTDataSource {
  constructor() {
    super();
    this.baseURL = "https://api.example.com/";
  }

  async myRestApiCall() {
    // 这里可以重写 RestDataSource 的 fetch 方法，实现自定义逻辑
    const response = await this.get("/api/my-rest-api");
    return response;
  }
}

在这个例子中，我们定义了一个名为 MyRestDataSource 的子类，并重写了 fetch 方法以实现自定义逻辑。在这个 fetch 方法中，我们向 /api/my-rest-api 发送了一个 GET 请求，然后将响应返回。你可以使用 RestDataSource 支持的其他请求方法来调用 REST API。

3. 在 GraphQL 中使用 MyRestDataSource

最后，我们需要在 GraphQL 中使用刚刚创建的 MyRestDataSource。为此，我们需要在创建 ApolloServer 时传入 dataSources 参数，指定数据源。

const { ApolloServer, gql } = require("apollo-server");
const typeDefs = gql`
  type Query {
    myApi: String
  }
`;

const resolvers = {
  Query: {
    myApi: async (_, __, { dataSources }) => {
      const response = dataSources.myRestDataSource.myRestApiCall();
      return response;
    },
  },
};

const server = new ApolloServer({
  typeDefs,
  resolvers,
  dataSources: () => ({
    myRestDataSource: new MyRestDataSource(),
  }),
});

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

在这个例子中，我们创建了一个 GraphQL 查询 myApi。然后，我们在 resolvers 中使用 dataSources.myRestDataSource.myRestApiCall() 来调用刚刚创建的 MyRestDataSource。

4. 在 Apollo Studio 中使用 MyRestDataSource

如果你正在使用 Apollo Studio，你可以使用 Remote Schema 和 Data Sources 配置来使得你的 MyRestDataSource 能够在 API Gateway 中被使用。这里不再赘述。

总结

本文介绍了如何在 GraphQL 中使用 RestDataSource 连接 REST API 的技术实现，详细介绍了使用 RestDataSource 的步骤，并附上了示例代码。希望本教程能为读者带来指导意义。

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