将 GraphQL 模式从非 JS 服务器公开给 JS 客户端

Expose GraphQL schema from non-JS server to a JS client

本文关键字:JS 客户端 服务器 模式 GraphQL      更新时间:2023-09-26

我有一个用Java实现的GraphQL服务器和一个JavaScript客户端来查询它。我不喜欢的是客户端只需要知道架构,而不能从服务器获取它并动态地针对它构建查询。

现在,我知道 GraphiQL 以某种方式做到了这一点,但我猜这是因为它的后端也是用 JavaScript 编写的,因此客户端和服务器都可以使用它。我的模式是用 Java 定义的,但可能有一种方法可以自动生成客户端可以使用的 JavaScript 表示。

这样的事情已经存在了吗?

现在,我知道 GraphiQL 以某种方式做到了这一点,但我猜这是因为它的后端也是用 JavaScript 编写的,因此客户端和服务器都可以使用它。

实际上,(幸运的是)情况并非如此。它是用Javascript编写的,但它不需要实现这种行为。

我有一些好消息要告诉你...

内省!

关于 GraphQL 的一个很棒的事情是,事实上,客户端不必知道任何关于模式的信息,因为它可以使用内省来查询服务器。事实上,如果您没有明确提供模式来自动填充它,GraphiQL 将自动使用它。

从 GraphiQL 自述文件的 Props 部分:

schema:一个 GraphQLSchema 实例,如果不要使用,则为 null。如果提供了未定义,GraphiQL 将使用提取器发送内省查询以生成模式。

官方的 GraphQL Introspection 文档将为您提供更多信息和示例查询。他们查询其星球大战示例架构的示例:

{
  __schema {
    types {
      name
    }
  }
}

这将返回所有类型的名称。内省是 GraphQL 规范的一部分,因此每个 GraphQL 服务器都应该能够开箱即用:您不需要显式添加任何功能。