介绍
postgraphile-apollo-server 是一个基于 GraphQL 查询语言的自动化 API 构建工具。它能够将 PostgreSQL 数据库转换成一个 GraphQL 的 API,让开发者更加便捷地与数据库进行交互。本文将介绍如何使用 npm 包 postgraphile-apollo-server,帮助你快速构建基于 PostgreSQL 数据库的 GraphQL API。
前置条件
在使用 postgraphile-apollo-server 之前,需要安装以下软件:
- Node.js (大于 10 版本)
- PostgreSQL
安装
在 Node.js 项目中,可以通过 npm 来安装 postgraphile-apollo-server:
npm install postgraphile-apollo-server
设置
以下代码目录结构为例,假设你的 Node.js 项目主目录下有名为 index.js
的文件和名为 database.postgres
的数据库。
- project folder/ - index.js - database.postgres
在 index.js 中,需要添加以下代码:
-- -------------------- ---- ------- ----- - ------------ - - -------------------------------------- ----- --- - ---------- ----- ------ - --- -------------- ------- ----- -------------- --------- ----------- ----- ------------------- --------- ------------------- ----- ------------ ----- ----- ------- --------- -------------------- ------------------- --- --- ------------------------ --- --- ------------ ----- ---- -- -- -- ------------------- ----- -- -------------------------------------------- --
其中需要注意以下事项:
- schema 属性的值通过 postgraphile 函数来生成,需要传入一个包含数据库连接信息的对象。
- jwtPgTypeIdentifier 的值是你在 JWT 鉴权设置中自定义的数据类型名称,需要替换为对应的名称。
运行
运行以下命令来启动应用程序:
node index.js
查询
访问 http://localhost:4000/graphql,可以看到一个 GraphQL 的 IDE。通过在左侧写入 GraphQL 查询,可以查看 API 返回的结果。
下面是一个查询文章列表的例子:
-- -------------------- ---- ------- ----- - ----------- - ----- - -- ----- ------- - - -
结论
本文介绍了如何使用 npm 包 postgraphile-apollo-server 快速构建基于 PostgreSQL 数据库的 GraphQL API。通过了解 postgraphile-apollo-server 的使用,可以更加方便地开发自己的 API,并且可以掌握如何使用 GraphQL 查询语言来与数据进行交互。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600672693660cf7123b366b1