代理/转换现有的 GraphQL API 到 REST



我们有一个现有的私有 GraphQL 服务器来支持我们的 React 应用程序,并希望可能将功能的子集公开为 REST 端点。这样我们就不必支持 2 个代码库,一个用于 GraphQL,一个用于 REST API。

我将如何利用现有的 GraphQL 服务器并创建一个包装器/代理层来将架构公开为 REST 端点?

(编辑:有人最终建立了一个库来做我在下面描述的几乎!在这里尝试一下:https://www.npmjs.com/package/rest-graphql)

我认为最好的方法不是从架构中的类型生成 API,而是将特定查询公开为端点。这样,您可以返回要发送到客户端的数据的确切形状。最好的部分是,GraphQL 已经拥有您需要的所有工具,包括参数处理!

例如,您要创建一个终结点:

/posts/1

假设您希望将其映射到此查询:

const postByIdQuery = `
query postById($postId: Int!) {
post(id: $postId) {
title
description
author {
name
}
}
}
`;

然后在服务器端 REST API 库(例如 express)中,您可以执行以下操作:

app.get('/posts/:postId', function (req, res) {
graphql(
schema, // same schema as your graphql api
postByIDQuery, // the query from above
rootValue, context, // set these same way as for your graphql endpoint
req.params // use the route params as variables!
).then((result) => {
res.send(result);
}).catch((error) => {
// something to handle errors
});;
})

如果你有很多要创建的端点,我会创建一个帮助程序函数,如下所示:

function addEndpointFromQuery(app, path, query) {
// generates endpoint like the above sample
}

这里真正巧妙的是,您的路由参数(在这种情况下:postId)只需要与您声明的查询变量($postId)匹配,然后它们可以自动连接在一起!然后,您可以简单地调用帮助程序函数来执行上述操作:

addEndpointFromQuery(app, '/posts/:postId', `
query postById($postId: Int!) {
post(id: $postId) {
title
description
author {
name
}
}
}
`);

如果需要,还可以添加额外的参数来转换结果以适合所需的 REST 响应格式。

我认为有人可以构建一个库来做到这一点,但感觉它会非常特定于应用程序,具有特定的响应格式、生成上下文的方式等。因此,我个人建议像上面那样编写自己的助手,并且可能只需不到 50 行代码即可完成。

看看这个包(graphql2rest): https://github.com/sisense/graphql2rest

您可以使用它从现有的 GraphQL API 自动生成 REST API - 这正是您所需要的。

"GraphQL2REST是一个Node.js库,它读取你的GraphQL模式和用户提供的清单文件,并自动生成一个具有完全RESTful HTTP路由的Express路由器 - 一个成熟的REST API。

最新更新