npm 包 trailpack-postgraphql 使用教程

阅读时长 4 分钟读完

介绍

Trailpack-postgraphql 是一个可以快速和简单地集成 GraphQL API 于 Sails 应用程序的简单 GraphQL 服务。

这个包使用一个称为 postgraphql 的库,该库充分利用 PostgreSQL 的内省来自动为您创建 GraphQL API。它允许您创建基于数据库的 API,而无需先定义模式。这大大加速了开发流程并提高了可维护性。

安装

使用 NPM 安装 trailpack-postgraphql:

安装完成后,将以下代码行添加到 config/main.js 文件中:

-- -------------------- ---- -------
-------------- - -
  -- ---

  -- ----
  ------ -
    -- ---

    --------------------------------
  -
-

使用

配置

在安装完成后,在 config/graphql.js 中进行配置:

-- -------------------- ---- -------
-------------- - -
  ---
   - -------------
   --
  ------------ -
    ------- --------- -- --------------
    ---------- --------- -- -------------
    ----------- ----- -- -----
    ------------- ------- -- ----------
  --
  -- ---
-

示例代码

-- -------------------- ---- -------
---
 - ----------
 -
 - --------------------
 --
-------------- - -
  ----- ---- ----- -
    ----- --------- - --------------------------
    ----- ----- - ----------------------
    ----- ------ - ----- ------------------------ ----------

    -------- - ------
  -
-

在以上示例中,我们在控制器中使用了 ctx.graphql.query() 方法,这个方法是从 trailpack-postgraphql 注入到程序中的。ctx 表示当前请求的上下文对象。

GraphQL 客户端

如果你使用的是 React,那么可使用 Apollo Client 来使 GraphQL 查询更容易。

这里是一个小例子:

-- -------------------- ---- -------
------ - ------------- -------------- -------- - ---- ----------------

----- ------ - --- --------------
  ------ --- ----------------
  ----- --- ----------
    ---- ----------- -- ------- --- ---
    -----
  --
--

--------------
  ------ --------
    ----- -
      ---------- -
        ----- -
          --
          -----
          ---------
        -
      -
    -
  -
-------------- -- --------------------

总结

这个 npm 包解决了前端开发人员在构建基于数据库的 API 时遇到的许多问题。 postgraphql 库的自动内省使得构建 GraphQL API 可以更加快速和简单。

该包提供了良好的支持文档和示例代码。如果你还没有使用 GraphQL API,试试这个 npm 包吧!

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005577a81e8991b448d479d

纠错
反馈