@ graphql-schema- filter/ 核心
GraphQL 筛选库 @expose 指令支持基于目标的访问控制.
特征
- 基于目标的过滤: 基于
@expose以标签为基础的访问控制指令 - 智能默认: 自动曝光输出类型字段,允许输入类型处理,明确查询/混合字段控制
- 类型安全: 包含全面类型定义的完整类型脚本支持
- 零配置: 有合理默认的简单 API
- 生产准备: 有源地图和声明文件的双格式(ESM + CJS)
安装
npm install @graphql-schema-filter/core graphql
快速启动
import { buildSchema } from "graphql";
import { filterSchema } from "@graphql-schema-filter/core";
const schema = buildSchema(`
directive @expose(tags: [String!]!) repeatable on FIELD_DEFINITION | INPUT_FIELD_DEFINITION
type Query {
users: [User!]! @expose(tags: ["readonly", "admin"])
adminUsers: [User!]! @expose(tags: ["admin"])
}
type User {
id: ID!
name: String!
email: String!
salary: Float @expose(tags: ["admin"])
}
`);
// Filter for readonly users
const readonlySchema = filterSchema(schema, {
target: "readonly",
});
// Filter for admin users
const adminSchema = filterSchema(schema, {
target: "admin",
});
API 密码
filterSchema(schema, options)
过滤 GraphQL 计划的主要切入点 .
参数:
schema: GraphQLSchema- 过滤的 GraphQL 方案options: FilterSchemaOptionstarget: string- 过滤的目标标记(例如“admin”、“只读”)logLevel?: LogLevel- 日志级别(例如“调试”、“信息”、“警告”、“无”)(默认:“无”)formatOptions?: FormatSchemaOptions- Schema格式化选项(默认:字母排序)
回返情况: GraphQLSchema - 过滤计划
导出类型
import type {
FilterSchemaOptions,
FormatSchemaOptions,
DefinitionsSortOptions,
SortFieldsOptions,
} from "@graphql-schema-filter/core";
FormatSchemaOptions
控制被过滤的 schema 输出的格式.
interface FormatSchemaOptions {
definitionsSort: DefinitionsSortOptions;
fieldsSort: SortFieldsOptions;
}
type DefinitionsSortOptions =
| { type: "alphabetical" } // Sort by group then alphabetically
| { type: "none" }; // Preserve original order
type SortFieldsOptions =
| { type: "alphabetical" } // Sort fields alphabetically
| { type: "none" }; // Preserve original order
定义组(按顺序排列):
- 根类型( 查询、 变异、 订阅)
- 斯卡尔
- 指令
- 命名类型( 对象、 界面、 输入、 联盟、 Enum - 按字母排序)
指令定义
包包括一个 directives.graphql 文件位于 dist/directives.graphql。您可以将该文件链接到您的工程,或者根据需要将定义复制到您的计划:
ln -s node_modules/@graphql-schema-filter/core/dist/directives.graphql src/graphql/directives.graphql
指令
@expose(tags: [String!]!)
标记字段为暴露于特定目标.
directive @expose(
tags: [String!]!
) repeatable on FIELD_DEFINITION | INPUT_FIELD_DEFINITION
@disableAutoExpose
禁用某种类型的自动字段曝光( 如查询/ 混合等处理) .
directive @disableAutoExpose on OBJECT | INTERFACE
文档
关于详细文件、实例和先进用途,请访问 GitHub 仓库。 。 。 .
许可证
麻省理工学院