# @graphql-authz/apollo-server-plugin 中文文档

规范地址：https://npmcn.com/package/%40graphql-authz/apollo-server-plugin/

版本：3\.1\.3
npm 元数据更新时间：2024-08-12T16:09:30.851Z
中文译文更新时间：2026-11-17T03:23:02.461Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40graphql-authz/apollo-server-plugin
原文对照：https://npmcn.com/package/%40graphql-authz/apollo-server-plugin/?lang=original
项目主页：https://github.com/AstrumU/graphql-authz#readme
源码仓库：https://github.com/AstrumU/graphql-authz

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：11.4 kB，6 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@apollo/server ^4\.0\.0，@graphql-authz/core ^1\.3\.2，graphql ^14\.0\.0 \|\| ^15\.0\.0 \|\| ^16\.0\.0
- 首次发布：2021-09-09T20:07:33.418Z
- 最新版本发布：2024-08-12T16:09:30.663Z
- 近 30 天下载量：8013（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：9（近 12 个月 0 个）

## 中文简介

图克-奥斯兹的阿波罗服务器插件

## 安装

```sh
npm install @graphql-authz/apollo-server-plugin
```

也可以使用：`pnpm add @graphql-authz/apollo-server-plugin`、`yarn add @graphql-authz/apollo-server-plugin`、`bun add @graphql-authz/apollo-server-plugin`

## README

# @graphql-authz/ apollo-server-plugin (英语)

## 配置阿波罗服务器

确保配置上下文解析器以进行认证,并在上下文中添加用户信息

```ts
const server = new ApolloServer({
  ...
  context: ({ req }) => {
    return {
      user: someHowAuthenticateUser(req.get("authorization"))),
    };
  },
  ...
});
```

### 用于指令的使用

应用 authZ Directive Transfer 到 schema 并添加插件到 apollo 服务器

```ts
  import { makeExecutableSchema } from '@graphql-tools/schema';
  import { authZDirective } from '@graphql-authz/directive';
  import { authZApolloPlugin } from "@graphql-authz/apollo-server-plugin";

  const { authZDirectiveTransformer } = authZDirective();

  const schema = makeExecutableSchema({
    typeDefs,
    resolvers
  });
  
  const transformedSchema = authZDirectiveTransformer(schema);

  const server = new ApolloServer({
    ...
    schema: transformedSchema,
    plugins: [authZApolloPlugin({ rules })],
    ...
  });
```

### 用于扩展用途

向 apollo 服务器添加插件

```ts
  import { authZApolloPlugin } from "@graphql-authz/apollo-server-plugin";;

  const server = new ApolloServer({
    ...
    plugins: [authZApolloPlugin({ rules })],
    ...
  });
```

### 用于 AuthSchema 用途

在 apollo 服务器上添加插件并附加一个参数 `authSchema`

```ts
  import { authZApolloPlugin } from "@graphql-authz/apollo-server-plugin";;

  const server = new ApolloServer({
    ...
    plugins: [authZApolloPlugin({ rules, authSchema })],
    ...
  });
```

## 常见问题

### @graphql-authz/apollo-server-plugin 是什么？

图克-奥斯兹的阿波罗服务器插件

### 如何安装 @graphql-authz/apollo-server-plugin？

在项目目录运行 npm install @graphql-authz/apollo-server-plugin，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@apollo/server（^4\.0\.0）、@graphql-authz/core（^1\.3\.2）、graphql（^14\.0\.0 \|\| ^15\.0\.0 \|\| ^16\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @graphql-authz/apollo-server-plugin 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @graphql-authz/apollo-server-plugin 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @graphql-authz/apollo-server-plugin 可以商用吗？

@graphql-authz/apollo-server-plugin 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @graphql-authz/apollo-server-plugin 的下载量有多少？

根据 npm 官方下载统计，@graphql-authz/apollo-server-plugin 在 2026/10/17 – 2026/11/15 这 30 天内被下载 8,013 次，日均约 267 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @graphql-authz/apollo-server-plugin 还在维护吗？

最新版本 3\.1\.3 发布于 2024/08/13（2 年前）；至今共发布 9 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/09/10。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

