GraphQLAuthz 项目使用教程

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

graphql-authz 是一个用于在 GraphQL 项目中添加授权层的开源项目。以下是其主要目录结构和文件介绍：

graphql-authz/
├── examples/                        # 包含不同框架和配置的示例代码
├── packages/
│   ├── core/                        # 核心代码包，包含授权规则的实现
│   └── directive/                   # 包含用于指令的代码
├── scripts/                         # 脚本目录，包含项目构建和测试脚本
├── .changeset/                      # 用于管理变更集的目录
├── .github/                         # GitHub 工作流和配置文件
├── .gitignore                       # 指定 Git 忽略的文件和目录
├── .npmignore                       # 指定 npm 忽略的文件和目录
├── .nvmrc                           # 指定 Node.js 版本的配置文件
├── .prettierrc                      # Prettier 配置文件
├── LICENSE                          # 项目许可证
├── README.md                        # 项目说明文件
├── jest.config.js                   # Jest 测试配置文件
├── package.json                     # 项目 npm 配置文件
├── pnpm-lock.yaml                    # pnpm 锁文件
├── pnpm-workspace.yaml               # pnpm 工作空间配置文件
└── tsconfig.json                    # TypeScript 配置文件

2. 项目的启动文件介绍

graphql-authz 项目的启动通常依赖于具体的框架和配置。以下是一个基于 Apollo Server 的简单启动示例：

// index.js 或 app.js
import { ApolloServer } from 'apollo-server';
import { typeDefs } from './schema'; // 你的 GraphQL schema 文件
import { resolvers } from './resolvers'; // 你的 GraphQL resolvers 文件
import { authZRule } from '@graphql-authz/core'; // 引入授权规则

const server = new ApolloServer({
  typeDefs,
  resolvers,
  context: ({ req }) => {
    // 从请求中提取用户信息
    const user = req.headers.authorization;
    return { user };
  },
  plugins: [
    {
      // 使用 graphql-authz 插件
      requestDidStart: () => ({
        executionDidStart: ({ context }) => {
          if (!context.user) {
            throw new Error('Not authenticated');
          }
        },
      }),
    },
  ],
});

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

3. 项目的配置文件介绍

配置文件通常包含项目的各种设置和参数。以下是一些常见的配置文件介绍：

• package.json: 包含项目的元数据、依赖关系和脚本。例如：

{
  "name": "graphql-authz",
  "version": "1.0.0",
  "description": "A GraphQL authorization layer",
  "main": "index.js",
  "scripts": {
    "start": "node index.js",
    "test": "jest"
  },
  "dependencies": {
    "apollo-server": "^2.20.0",
    "graphql": "^15.5.0",
    "graphql-authz": "^1.0.0"
  }
}

• .env: 环境变量文件，用于存储敏感信息和配置参数，如数据库连接字符串、API密钥等。

• tsconfig.json: TypeScript 配置文件，定义了 TypeScript 编译器的选项，如模块解析、编译选项等。

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true
  },
  "include": ["**/*.ts"]
}

通过以上介绍，您可以开始搭建和使用 graphql-authz 项目，并根据具体需求进行配置和扩展。