GraphQL Armor 项目教程

GraphQL Armor 项目教程

graphql-armor 🛡️ The missing GraphQL security security layer for Apollo GraphQL and Yoga / Envelop servers 🛡️ 项目地址: https://gitcode.com/gh_mirrors/gr/graphql-armor

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

graphql-armor/
├── .github/
│   └── workflows/
├── docs/
├── examples/
├── src/
│   ├── __tests__/
│   ├── config/
│   ├── middleware/
│   ├── utils/
│   └── index.ts
├── .gitignore
├── package.json
├── README.md
└── tsconfig.json

• .github/: 包含 GitHub Actions 的工作流配置文件。
• docs/: 存放项目的文档文件。
• examples/: 包含项目的示例代码。
• src/: 项目的源代码目录。
  • tests/: 存放项目的测试代码。
  • config/: 存放项目的配置文件。
  • middleware/: 存放项目的中间件代码。
  • utils/: 存放项目的工具函数。
  • index.ts: 项目的入口文件。
• .gitignore: Git 忽略文件配置。
• package.json: 项目的依赖和脚本配置文件。
• README.md: 项目的介绍和使用说明。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.ts。该文件是整个项目的入口点，负责初始化 GraphQL 服务器并加载必要的中间件和配置。

import { ApolloServer } from 'apollo-server';
import { applyMiddleware } from 'graphql-middleware';
import { makeExecutableSchema } from '@graphql-tools/schema';
import { typeDefs, resolvers } from './schema';
import { permissions } from './middleware/permissions';

const schema = makeExecutableSchema({ typeDefs, resolvers });
const schemaWithMiddleware = applyMiddleware(schema, permissions);

const server = new ApolloServer({ schema: schemaWithMiddleware });

server.listen().then(({ url }) => {
  console.log(`🚀 Server ready at ${url}`);
});

3. 项目的配置文件介绍

项目的配置文件主要存放在 src/config/ 目录下。常见的配置文件包括：

• config.ts: 项目的全局配置文件，包含数据库连接、环境变量等信息。
• permissions.ts: 权限配置文件，定义了 GraphQL 查询和变更的权限规则。

// src/config/config.ts
export const config = {
  databaseUrl: process.env.DATABASE_URL || 'mongodb://localhost:27017/graphql-armor',
  environment: process.env.NODE_ENV || 'development',
};

// src/config/permissions.ts
import { shield, rule } from 'graphql-shield';

const isAuthenticated = rule()((parent, args, ctx) => {
  return ctx.user !== null;
});

export const permissions = shield({
  Query: {
    user: isAuthenticated,
  },
  Mutation: {
    createUser: isAuthenticated,
  },
});

以上是 GraphQL Armor 项目的目录结构、启动文件和配置文件的介绍。通过这些内容，您可以更好地理解和使用该项目。

graphql-armor 🛡️ The missing GraphQL security security layer for Apollo GraphQL and Yoga / Envelop servers 🛡️ 项目地址: https://gitcode.com/gh_mirrors/gr/graphql-armor