Mongo-GraphQL-Starter 项目教程

Mongo-GraphQL-Starter 项目教程

mongo-graphql-starterCreates a fully functioning, performant, extensible GraphQL endpoint from a Mongo DB. Supports middleware, Mongo 4 transactions.项目地址:https://gitcode.com/gh_mirrors/mo/mongo-graphql-starter

1. 项目的目录结构及介绍

Mongo-GraphQL-Starter 项目的目录结构如下：

mongo-graphql-starter/
├── config/
│   ├── default.json
│   ├── development.json
│   ├── production.json
│   └── test.json
├── data/
│   └── migrations/
├── src/
│   ├── api/
│   │   ├── mutations/
│   │   ├── queries/
│   │   └── types/
│   ├── config/
│   ├── db/
│   ├── schema/
│   └── server.js
├── .env
├── .gitignore
├── package.json
└── README.md

目录结构介绍

• config/：包含不同环境的配置文件。
  • default.json：默认配置文件。
  • development.json：开发环境配置文件。
  • production.json：生产环境配置文件。
  • test.json：测试环境配置文件。
• data/：数据库迁移文件存放目录。
  • migrations/：数据库迁移脚本。
• src/：源代码目录。
  • api/：GraphQL API 相关代码。
    • mutations/：GraphQL 变更操作。
    • queries/：GraphQL 查询操作。
    • types/：GraphQL 类型定义。
  • config/：项目配置相关代码。
  • db/：数据库连接相关代码。
  • schema/：GraphQL 模式定义。
  • server.js：服务器启动文件。
• .env：环境变量配置文件。
• .gitignore：Git 忽略文件配置。
• package.json：项目依赖和脚本配置。
• README.md：项目说明文档。

2. 项目的启动文件介绍

项目的启动文件是 src/server.js。该文件负责启动 GraphQL 服务器，并配置相关中间件和路由。

启动文件主要内容

const express = require("express");
const { ApolloServer } = require("apollo-server-express");
const { typeDefs, resolvers } = require("./schema");
const { connectToDb } = require("./db");
const { getConfig } = require("./config");

async function startServer() {
  const app = express();
  const config = getConfig();

  await connectToDb(config.db);

  const server = new ApolloServer({ typeDefs, resolvers });
  await server.start();

  server.applyMiddleware({ app });

  app.listen({ port: config.port }, () => {
    console.log(`Server ready at http://localhost:${config.port}${server.graphqlPath}`);
  });
}

startServer();

启动文件功能介绍

• 引入必要的模块和配置。
• 连接到 MongoDB 数据库。
• 创建 ApolloServer 实例并启动。
• 配置 Express 服务器并监听指定端口。

3. 项目的配置文件介绍

项目的配置文件存放在 config/ 目录下，包括 default.json、development.json、production.json 和 test.json。

配置文件示例

{
  "port": 4000,
  "db": {
    "uri": "mongodb://localhost:27017/mydatabase"
  }
}

配置文件功能介绍

• port：服务器监听的端口。
• db：数据库连接配置。
  • uri：MongoDB 连接字符串。

这些配置文件通过 src/config/index.js 文件加载，根据环境变量 NODE_ENV 选择相应的配置文件。

const dotenv = require("dotenv");
const path = require("path");
const fs = require("fs");

dotenv.config();

const env = process.env.NODE_ENV || "development";

const configPath = path.resolve(__dirname, "..", "config", `${env}.json`);
const config = JSON.parse(fs.readFileSync(configPath, "utf-

mongo-graphql-starterCreates a fully functioning, performant, extensible GraphQL endpoint from a Mongo DB. Supports middleware, Mongo 4 transactions.项目地址:https://gitcode.com/gh_mirrors/mo/mongo-graphql-starter