symbolplatform/symbol-rest Docker 镜像 - 轩辕镜像 | Docker 镜像高效稳定拉取服务

Symbol REST网关服务镜像文档

镜像概述

Symbol REST网关服务是Symbol生态中的核心组件，作为应用程序与节点之间的中间层，提供标准化的HTTP API接口，简化应用与Symbol的交互流程。该服务封装了节点的底层通信逻辑，为开发者提供直观、易用的RESTful API，支持各类***数据访问与操作需求。

核心功能与特性

核心功能

• 数据查询：支持查询账户信息、交易记录、区块详情、资产余额等核心数据
• 交易处理：提供交易提交接口，支持交易状态查询与验证
• 节点与网络监控：获取***节点健康状态、网络拓扑结构及共识信息
• 标准化API：遵循OpenAPI规范，提供清晰的接口文档与请求/响应格式

主要特性

• 低耦合设计：独立于具体应用，可灵活对接不同Symbol***节点
• 高可用性：支持多节点连接配置，实现节点故障自动切换
• 可扩展性：支持水平扩展，通过负载均衡提升服务处理能力
• 安全可靠：内置请求验证机制，防范***请求与数据篡改

使用场景与适用范围

适用场景

• 开发基于Symbol的应用，通过API查询账户余额、交易历史
• 构建***浏览器，展示区块、交易、账户等链上数据
• 开发去中心化应用（DApp），实现与***的交互（如交易提交、数据上链）
• 搭建***监控系统，实时获取节点状态与网络健康度

适用用户

• ***应用开发者
• ***基础设施运维人员
• 需要通过REST API与Symbol***交互的技术团队

使用方法与配置说明

快速启动

通过以下命令快速启动Symbol REST网关服务：

bash
docker run -d \
  --name symbol-rest-gateway \
  -p 3000:3000 \
  -e SYMBOL_NODE_URL=http://symbol-node:3000 \
  -e LOG_LEVEL=info \
  symbol/rest-gateway:latest

环境变量配置

服务支持通过环境变量进行配置，常用参数如下：

持久化配置（可选）

如需自定义配置文件，可通过挂载卷的方式加载本地配置：

bash
docker run -d \
  --name symbol-rest-gateway \
  -p 3000:3000 \
  -v ./custom-config:/app/config \
  symbol/rest-gateway:latest

注：自定义配置文件需放置于挂载目录下，命名为config.json，配置项优先级高于环境变量。

验证服务可用性

服务启动后，可通过以下命令验证是否正常运行：

bash
curl http://localhost:3000/health

若返回状态为"status": "ok"，表示服务启动成功。

常用API端点示例

• 查询账户信息：GET /accounts/{address}
• 查询交易详情：GET /transactions/{transactionId}
• 提交交易：POST /transactions
• 获取区块信息：GET /blocks/{height}
• 获取网络信息：GET /network/properties

详细API文档可访问服务内置的Swagger界面：http://localhost:3000/swagger