仅 DataPower API Gateway

为 GraphQL API 启用 GraphiQL 编辑器

如果在创建 GraphQL 代理 API 时选择 启用 GraphiQL 编辑器 选项,那么用户可以通过在 Web 浏览器中使用 GraphiQL 编辑器来测试 API; API Connect 使用支持从 GraphiQL 编辑器进行测试的 HTML 页面来响应初始 GraphiQL 编辑器请求。

禁用 启用 GraphiQL 编辑器 选项可减少网关流量和等待时间,此外,无论您是否启用此选项, Developer Portal 都将提供等效的测试功能。

此选项会自动将以下属性设置添加到 GraphQL 代理 API 的 OpenAPI 源:
html-page: 'store:///graphiql.html'
如果在创建 API 期间禁用启用 GraphiQL 编辑器,但在这之后又决定需要它,那么可以手动添加此属性设置,也可以在 API 的设计选项卡的 API 设置页面上选择启用 GraphiQL 编辑器
注:
  • html-page 属性只应与 GraphQL 代理 API 配合使用。
  • store:///graphiql.htmlhtml-page 属性唯一允许的值。
  • 如果添加了 html-page 属性,但在创建 API 期间未启用支持标准自省属性,那么 GraphiQL HTML 页面将不会显示有关 GraphQL 后端服务器、执行查询验证或执行智能查找的任何文档。 有关如何手动创建所需组合件策略配置的详细信息,请参阅 支持 GraphQL API 的自省