json2graphql 使用教程

json2graphql 使用教程

json2graphql From a JSON file to postgres-backed realtime GraphQL 项目地址: https://gitcode.com/gh_mirrors/jso/json2graphql

1. 项目介绍

json2graphql 是一个开源工具，它可以将 JSON 文件导入到 Postgres 数据库中，并创建相应的 GraphQL 架构，使用户能够通过 Hasura GraphQL 引擎实时查询数据。这个工具非常适合快速启动一个 GraphQL 后端，或者将现有的 JSON 数据集导入到 Postgres 并进行查询。

2. 项目快速启动

安装

首先，确保你已经安装了 Node.js。然后，你可以通过以下命令全局安装 json2graphql：

npm install -g json2graphql

准备 JSON 数据

创建一个 JSON 文件，例如 db.json，其内容应为一个包含实体名称作为键，实体列表作为值的 JSON 对象。例如：

{
  "user": [
    { "id": 1, "name": "John Doe" },
    { "id": 2, "name": "Jane Doe" }
  ],
  "post": [
    { "id": 1, "title": "Lorem Ipsum", "views": 254, "user_id": 1 },
    { "id": 2, "title": "Sic Dolor amet", "views": 65, "user_id": 2 }
  ]
}

运行 Hasura 和 Postgres

在 Heroku 上运行 Hasura GraphQL 引擎和 Postgres。你可以通过点击 Heroku 的按钮来部署，并记下 URL，假设它是 https://j2gtest.herokuapp.com。

导入 JSON 数据

使用以下命令将你的 JSON 数据导入到 Hasura：

json2graphql https://j2gtest.herokuapp.com -d ./path/to/db.json

如果 Hasura 需要管理员密钥，则可以使用 -s <admin-secret> 选项。

运行 GraphQL 查询

一旦数据被导入，你可以使用 Hasura GraphQL 引擎进行查询。例如：

query {
  user {
    id
    name
    postsByUserId {
      id
      title
    }
  }
}

3. 应用案例和最佳实践

快速启动一个 GraphQL 后端

你可以使用 json2graphql 快速初始化一个包含用户、帖子、评论等实体的 GraphQL 聊天后端。

使用 MongoDB 数据

如果你有 MongoDB 数据，可以将其导出为 JSON，然后使用 json2graphql 将其导入到 Postgres 中，并开始使用 GraphQL 进行查询。

查询现有 JSON 数据集

挑选一个 JSON 数据集，导入到新的或现有的 Hasura/Postgres 实例中，然后开始查询。

4. 典型生态项目

• Hasura：一个开源的实时 GraphQL 引擎，可以与 json2graphql 一起使用来提供实时 GraphQL API。
• Postgres：一个功能强大的开源关系型数据库，用于存储 json2graphql 导入的数据。
• Node.js：一个开源的 JavaScript 运行环境，用于运行 json2graphql 命令行工具。

通过这些开源项目的结合，开发者可以快速构建功能丰富的 GraphQL 应用程序。

json2graphql From a JSON file to postgres-backed realtime GraphQL 项目地址: https://gitcode.com/gh_mirrors/jso/json2graphql