在现代 Web 开发中,GraphQL 已成为了前后端交互中极其重要的一环。作为一种强类型的查询语言,它的使用极大地简化了前后端数据交互的繁琐。本文将介绍一个 npm 包 graphql-endpoint,它能够帮助开发者轻松地将 GraphQL 服务部署到云端,并提供更优秀的 API 体验。
安装
安装包非常简单,只需要在命令行执行以下命令即可:
npm install graphql-endpoint
使用方法
graphql-endpoint 的使用方法十分简单,一共只需要三步:
1. 安装依赖
在项目目录下,执行以下命令安装依赖包:
npm install --save express body-parser graphql graphql-endpoint
上面的依赖包中,express 和 body-parser 是一个 Web 服务器基础库,而 graphql-endpoint 是我们本文所讲的 npm 包。
2. 初始化 graphql-endpoint
在你的项目代码文件中,先引入所需的库和模块,然后创建 GraphQL 实例、启动 Web 服务器,如下所示:
-- -------------------- ---- ------- ----- - -------- ------------- - - ---------------------------- ----- ------- - ------------------- ----- ---------- - ----------------------- ----- --- - ---------- --------------------------- ----- ------ - --- --------------- -- ----- -- ------- ------ --- ----- ------- - --- ---------------- ------------- ------------------ ----- ------ - ---------------- -- -- - ------------------- -- --------- -- ---- --------------------------- ---
在这个例子中,我们通过 GraphQLSchema
构造函数构造出一个 GraphQL 的 schema 实例,并传入 GraphQL
构造函数创建 GraphQL 实例。GraphQL 实例本身包含一个 endpoint
属性,将会作为 Web 服务器的请求处理函数来处理请求。
这里注意一下,我们通过 bodyParser
中间件解析 HTTP 请求 body 中的 JSON,GraphQL 使用 JSON 格式来接收和返回数据。然后使用 express 的 app.post
方法指定 Web 服务器将要处理的请求类型为 POST
,请求路径为 /
。
最后使用 app.listen
方法启动 Web 服务器,并在控制台输出监听的端口号。
3. 在代码中使用 GraphQL
在初始化代码中,我们有一行注释,TODO 添加 GraphQL Schema。这一步需要我们编写和定义我们的查询和修改操作。好在 GraphQL 自带了一个非常好的语法,可以很好地描述我们的 schema。
例如,以下代码描述了一个非常简单的 schema,它支持获取字符串的长度:
-- -------------------- ---- ------- ----- ------ - --- --------------- ------ - ---- ----- - --------- --------- ---- - -- ---------- - ------ - ------- ------ ----- -- ------------- - - ---
在这个 schema 中,我们定义了一个 Query
对象,它有一个名为 length
的属性,该属性的类型为 Int
。这里的 Int
是 GraphQL 天然支持的类型。在 resolvers
中我们指定了 length
的具体实现。当我们进行这个查询时,我们将会得到一个 JSON 格式的数据,它的值将会是字符串的长度。
总结
通过使用 graphql-endpoint
这个 npm 包,我们可以很容易地在云端和本地部署我们的 GraphQL 服务,并提供一些额外的 API 体验。在使用时只需要注意几个问题,如 HTTP 请求协议,数据响应格式等细节问题。这里只是介绍了使用 graphql-endpoint
的基础操作,还有很多高级操作和细节问题需要在实践中不断探索和总结。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600668efd9381d61a3540cf6