在现代 Web 应用中，前后端分离的架构已经成为了主流趋势。开发者们需要借助一些工具和框架来提升开发体验、提高开发效率和代码可维护性。而 GraphQL API 和 apollo-server 就是这样一组工具和框架。本文将介绍如何使用 npm 包 apollo-server，希望能对前端开发者有所帮助。
apollo-server 是什么？
apollo-server 是一个开箱即用的 GraphQL 服务器。它可以帮助我们快速地搭建起 GraphQL API，它包含：
- 后端服务器（响应请求、处理数据等）
- 自动生成文档（自动生成 API 文档，提高可维护性）
- 数据校验功能（检验前端传来的数据是否合法）
开发者可以使用 gql 语言定义自己的 Schema，即数据模型，从而在后端服务器中书写对应的数据处理方法。
如何使用 apollo-server？
安装：
$ npm install apollo-server-express
首先，我们需要安装 apollo-server-express 包，该包是基于 express 框架的封装，当然，你也可以使用其他框架。
入门示例：
-- -------------------- ---- -------
-- ----
----- - ------------- --- - - ---------------------------------
----- ------- - -------------------
-- -- --- ------
----- -------- - ----
---- ----- -
------ ------
-
--
-- -- --------
----- --------- - -
------ -
------ -- -- --------
--
--
-- --------- ------
----- ------ - --- --------------
---------
----------
---
-- --- -------
----- --- - ----------
-- - ------------- --- ------- ---
------------------------ --- ---
-- ----
------------ ----- ---- -- -- -- -
--------------- ------ ----- -- ---------------------------------------------
---上述代码中包含以下几个步骤：
- 引入 apollo-server-express，express 和 gql 依赖。
- 使用 gql 语言定义数据模型（Schema）。
- 书写 resolver 函数，用于处理数据逻辑。
- 使用 Apollo-Server 实例化服务器，将定义好的 schema 和 resolver 传入。
- 实例化 express 应用。
- 使用 server.applyMiddleware 将 apollo-server 集成到 express 中间件中。
- 启动服务器，监听 4000 端口。
apollo-server 配置选项
除了在例子中的基本启动配置外，apollo-server 支持许多其他配置选项。以下是一些在开发过程中可能有用的选项：
- debug - 开启 debug 模式，可以查看详细的日志输出
- formatError - 可以自定义处理异常的函数
- introspection - 决定是否启用 introspection，使用 introspection 可以方便地自动生成文档
- playground - 决定是否启用 playground，该选项用于测试 API 函数，可以方便地查看文档以及测试
- schema - 可以向服务器传输字符串形式的 schema，可以避免使用文件
更多配置选项详见官方文档：https://www.apollographql.com/docs/apollo-server/api/apollo-server/
在现有应用中使用 apollo-server
如果您的应用已经运行在 express 上，您可以把 apollo-server 挂在在现有的 express 实例上。这可以通过以下方式完成：
-- -------------------- ---- ------- ----- - ------------ - - --------------------------------- ----- ------- - ------------------- ----- --- - ---------- ----- ------ - --- -------------- --------- --------- --- -- ------ ------ ----------------- -------------- ------------------------ ---- ----- ------ ---
现在 apollo-server 已经挂在在 express 的 /api 路由上了。它可以处理所有的 GraphQL API 调用。当您访问 http://your-domain.com/api/graphql 时，您将能够测试 GraphQL API。
可以使用以下代码在一个端口上启动 express 应用，启用所有路由：
app.listen(9000, () => {
console.log(`🚀 Server ready at http://localhost:9000/`);
});结论
在本文中，我们学习了如何使用 npm 包 apollo-server，以前端开发者的角度为您提供了详细的使用指南和示例代码。在现代 Web 应用中使用 GraphQL API 将会成为趋势。对于自己的项目，强烈推荐您尝试使用 GraphQL API，并加上 apollo-server 的自动化工具。希望这篇文章对您有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/93623