欢迎阅读 @blocklet/server-js 的完整 API 参考。本部分为通过 Blocklet Server Client 提供的每个 GraphQL 查询、变更和类型提供了详细的文档。无论您是需要获取数据、修改服务器状态,还是了解您正在使用的数据结构,这都是您的综合指南。
API 分为三个主要类别:
查询
使用查询从 Blocklet Server 获取数据。这包括检索有关 blocklet、用户、角色和系统状态的信息。
变更
使用变更在 Blocklet Server 上创建、更新或删除数据。这包括安装 blocklet、管理用户和更新配置等操作。
类型
了解整个 API 中使用的数据结构。本节详细介绍了所有输入对象、枚举和响应类型。
查询
查询用于从 Blocklet Server 读取或获取数据。Blocklet Server Client 提供了一组方便的方法来包装这些 GraphQL 查询,使得无需编写原始 GraphQL 即可轻松检索信息。这些方法涵盖了从检查节点状态到获取详细用户信息等广泛的功能。
有关所有可用查询方法及其详细文档的完整列表,请访问查询部分。
变更
变更用于修改服务器端数据。这包括创建、更新或删除资源等操作。Blocklet Server Client 提供了一套全面的变更方法,允许您以编程方式管理 blocklet、用户和其他服务器资源的整个生命周期。
有关所有可用变更方法及其详细文档的完整列表,请访问变更部分。
类型
类型定义了您可以查询和发送的数据结构。这包括对象类型、输入类型和枚举。了解这些类型对于有效使用 API 至关重要,因为它们决定了请求和响应中数据的形状。
有关 API 中使用的所有数据类型的完整参考,请访问类型部分。