GraphQL MongoDB 示例项目教程
1. 项目的目录结构及介绍
graphql-mongodb-example/
├── babel.config.js
├── package.json
├── src/
│ ├── index.js
│ ├── schema.js
│ ├── resolvers.js
│ ├── db.js
│ └── utils.js
├── .gitignore
└── README.md
babel.config.js
: Babel 配置文件,用于转译 JavaScript 代码。package.json
: 项目依赖和脚本配置文件。src/
: 源代码目录。index.js
: 项目启动文件。schema.js
: GraphQL 模式定义文件。resolvers.js
: GraphQL 解析器定义文件。db.js
: MongoDB 数据库连接配置文件。utils.js
: 工具函数文件。
.gitignore
: Git 忽略文件配置。README.md
: 项目说明文档。
2. 项目的启动文件介绍
src/index.js
是项目的启动文件,主要负责启动 Express 服务器并绑定 GraphQL 和 GraphiQL 接口。
const express = require('express');
const bodyParser = require('body-parser');
const { graphqlExpress, graphiqlExpress } = require('apollo-server-express');
const { makeExecutableSchema } = require('graphql-tools');
const typeDefs = require('./schema');
const resolvers = require('./resolvers');
const db = require('./db');
const schema = makeExecutableSchema({ typeDefs, resolvers });
const app = express();
app.use('/graphql', bodyParser.json(), graphqlExpress({ schema }));
app.use('/graphiql', graphiqlExpress({ endpointURL: '/graphql' }));
const PORT = process.env.PORT || 3001;
db.connect().then(() => {
app.listen(PORT, () => {
console.log(`Server is running on http://localhost:${PORT}`);
});
});
3. 项目的配置文件介绍
babel.config.js
Babel 配置文件,用于转译 JavaScript 代码,支持最新的 JavaScript 特性。
module.exports = {
presets: [
['@babel/preset-env', { targets: { node: 'current' } }]
]
};
package.json
项目依赖和脚本配置文件,包含了项目的基本信息、依赖包和脚本命令。
{
"name": "graphql-mongodb-example",
"version": "1.0.0",
"description": "A GraphQL and MongoDB example project",
"main": "src/index.js",
"scripts": {
"start": "nodemon src/index.js --exec babel-node"
},
"dependencies": {
"apollo-server-express": "^2.19.0",
"body-parser": "^1.19.0",
"express": "^4.17.1",
"graphql": "^15.4.0",
"graphql-tools": "^7.0.2",
"mongodb": "^3.6.3"
},
"devDependencies": {
"@babel/cli": "^7.12.10",
"@babel/core": "^7.12.10",
"@babel/node": "^7.12.10",
"@babel/preset-env": "^7.12.11",
"nodemon": "^2.0.7"
}
}
.gitignore
Git 忽略文件配置,用于指定不需要纳入版本控制的文件和目录。
node_modules
.env
README.md
项目说明文档,包含了项目的简介、安装步骤、使用说明等内容。
# GraphQL MongoDB 示例项目
这是一个简单的 GraphQL 和 MongoDB 示例项目,展示了如何使用 Apollo Server 和 Express 搭建一个 GraphQL 服务器,并连接到 MongoDB 数据库。
## 安装
1. 克隆项目: