概览硬件软件云平台
此页面由 AI 自动翻译。查看英文原版
Hub 控制
舰队管理
Luxonis HubAI
平台集成
组织
高级

本页目录

  • 端点
  • 公共集成边界
  • 实时内省
  • 在 GraphQL 客户端中检查
  • 最小内省请求
  • 工具集锦
  • 从已提交的操作生成类型化客户端
  • 选择与任务匹配的检查路径
  • 相关参考页面

GraphQL Schema

当您需要精确的 schema 端点、想要检查当前的公共 GraphQL 表面或需要 SDL 以用于工具和离线分析时，请使用此页面。
跳转至：

端点

使用这些端点进行 schema 检查：
  • GraphQL 端点： https://api.cloud.luxonis.com/graphql
  • 控制平面身份验证： Authorization: Bearer <your_api_key>
  • 内省访问：无需身份验证即可访问
  • 公共集成根： team { ... }
如果您需要请求形状基础知识或 GraphQL 术语，请继续阅读 关于 GraphQL。

公共集成边界

对于外部集成，请围绕公共 team { ... } 表面进行设计，并结合官方指南和参考页面以及 schema 检查。

实时内省

通过 GraphQL 端点内省当前的公共 schema：
Http
1https://api.cloud.luxonis.com/graphql
内省无需身份验证即可访问。如果您已使用经过身份验证的 GraphQL 客户端进行测试，则相同的端点在那里也同样适用。

在 GraphQL 客户端中检查

当您想交互式地浏览类型、字段、参数和枚举时，请使用 Altair 等 GraphQL 客户端。
  • 端点： https://api.cloud.luxonis.com/graphql
  • 最适合：在编写查询或变异之前检查字段名称、输入对象形状和枚举值

最小内省请求

如果您需要验证从您的环境中是否可以访问内省，请发送一个最小化的查询，如下所示：
Command Line
1curl -X POST https://api.cloud.luxonis.com/graphql \
2  -H "Content-Type: application/json" \
3  -d '{"query":"{ __schema { queryType { name } mutationType { name } } }"}'

工具集锦

从已提交的操作生成类型化客户端

对于生产应用程序，建议从您实际使用的查询和变异生成类型，而不是在每次更改时手动浏览 schema。使用 GraphQL Code Generator，将 schema 源指向：
Yaml
1schema: https://api.cloud.luxonis.com/graphql
2documents: ./src/**/*.graphql
这是实际的工作流程：
  • 定义您的集成所需的查询和变异
  • 针对当前 schema 生成类型
  • 将生成错误视为操作或 schema 合约已更改的信号

选择与任务匹配的检查路径

  • 当您需要快速检查一个字段、参数或输入形状时，请使用实时内省。
  • 当您已经知道要查找的操作类型时，请使用 查询 和 变异。

相关参考页面

Queries

Review the available read operations exposed by the public GraphQL API.

Mutations

Review the available write operations and team-scoped control flows.

Types

Inspect the public object and connection types returned by queries and mutations.

About GraphQL

Return to the request shape, public boundaries, and Hub-specific GraphQL usage patterns.