API 参考：Schema 报告插件

使用插件

本文档介绍了ApolloServerPluginSchemaReporting 插件的选项，你可以从 @apollo/server/plugin/schemaReporting 导入。

这个插件使你的 GraphQL 服务器 能够在每次启动时将其最新模式注册到 Apollo 模式注册表中。有关模式报告的详细信息，请参阅 Apollo Studio 文档。

为了使用此插件，你必须使用 图 API 密钥 配置你的服务器，可以通过 APOLLO_KEY 环境变量来实现，或者直接传递给您的 ApolloServer 构造函数（例如，new ApolloServer({apollo: {key: KEY}})）。这是与配置使用报告相同的方式。

你必须明确启用模式报告。如果您想使用默认配置来打开模式报告，可以将APOLLO_SCHEMA_REPORTING环境变量设置为true。

如果您想配置模式报告（或者更愿意通过代码而非使用环境变量来设置配置），导入ApolloServerPluginSchemaReporting插件并将其传递给ApolloServer构造函数：

1
import { ApolloServer } from '@apollo/server';
2
import { ApolloServerPluginSchemaReporting } from '@apollo/server/plugin/schemaReporting';
3

4
const server = new ApolloServer({
5
  typeDefs,
6
  resolvers,
7
  plugins: [ApolloServerPluginSchemaReporting()],
8
});

1
import { ApolloServer } from '@apollo/server';
2
import { ApolloServerPluginSchemaReporting } from '@apollo/server/plugin/schemaReporting';
3

4
const server = new ApolloServer({
5
  typeDefs,
6
  resolvers,
7
  plugins: [ApolloServerPluginSchemaReporting()],
8
});

使用插件与多个部署实例一起使用

单个实例运行插件 Apollo Server报告当前模式哈希到GraphOS的必要性。该哈希是模式版本的标识符，不包含任何使用数据。GraphOS仅当所有Apollo Server实例（一个或多个）报告相同的模式哈希时，才在变更日志中反映新的模式版本。

选项

1
new ApolloServer({
2
  plugins: [
3
    ApolloServerPluginSchemaReporting({
4
      overrideReportedSchema: schema
5
    }),
6
    ApolloServerPluginUsageReporting({
7
      overrideReportedSchema: schema
8
    }),
9
  ],
10
  // ...
11
})

禁用插件

仅当APOLLO_SCHEMA_REPORTING设置为true时，才会自动安装模式报告插件，因此禁用此插件的最简单方法是避免设置该环境变量（不要显式安装ApolloServerPluginSchemaReporting）。但是，如果您想确保 schema reporting 插件未安装在您的服务器上（也许是为了可能在设置环境变量任意的测试中运行的测试），您可以安装ApolloServerPluginSchemaReportingDisabled插件来禁用 schema reporting，如下所示：

1
import { ApolloServer } from '@apollo/server';
2
import { ApolloServerPluginSchemaReportingDisabled } from '@apollo/server/plugin/disabled';
3

4
const server = new ApolloServer({
5
  typeDefs,
6
  resolvers,
7
  plugins: [ApolloServerPluginSchemaReportingDisabled()],
8
});

1
import { ApolloServer } from '@apollo/server';
2
import { ApolloServerPluginSchemaReportingDisabled } from '@apollo/server/plugin/disabled';
3

4
const server = new ApolloServer({
5
  typeDefs,
6
  resolvers,
7
  plugins: [ApolloServerPluginSchemaReportingDisabled()],
8
});