@graphql-authz/apollo-server-plugin

中文文档
3.1.3发布于 2024/08/13MITTypeScriptCommonJS零依赖近 30 天下载 8013

Apollo Server plugin for graphql-authz

原始使用文档
文档目录4 节
  1. Configuring Apollo Server
  2. For Directives usage
  3. For Extensions usage
  4. For AuthSchema usage

@graphql-authz/apollo-server-plugin

Configuring Apollo Server

Ensure context parser is configured to perform authentication and add user info to context

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

For Directives usage

Apply authZDirectiveTransformer to schema and add plugin to apollo-server

  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 })],
    ...
  });

For Extensions usage

Add plugin to apollo-server

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

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

For AuthSchema usage

Add plugin to apollo-server with an additional parameter authSchema

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

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

版本与发布记录

@graphql-authz/apollo-server-plugin 共发布 9 个版本,首次发布于 2021/09/10;过去 12 个月发布了 0 个版本。

版本发布日期距今
3.1.3latest2024/08/132 年前
3.1.12023/11/302 年前
3.1.02023/06/273 年前
3.0.02023/01/253 年前
2.0.32022/09/124 年前
2.0.22021/12/224 年前

关于 @graphql-authz/apollo-server-plugin 的常见问题

@graphql-authz/apollo-server-plugin 是什么?

Apollo Server plugin for graphql-authz

如何安装 @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 和提交记录判断。