TON HTTP API 使用指南

TON HTTP API 使用指南

1. 项目目录结构及介绍

本节将概述ton-center/ton-http-api项目的主要目录结构及其重要组件。

主要目录和文件

• .gitignore: 控制哪些文件或目录不被Git版本控制。
• LICENSE: 项目的授权协议，采用GPL-3.0许可证。
• README.md: 项目简介和快速入门指南。
• configure.py: 脚本用于创建环境变量配置文件。
• docker-compose.yml, docker-compose.*.yaml: Docker Compose配置文件，用于管理服务容器。
• scripts: 包含辅助脚本，如环境准备脚本。
• ton-http-api: 主程序代码所在目录。

项目结构简洁明了，围绕HTTP API的核心功能展开，包含运行和服务配置的必要文件。

2. 项目的启动文件介绍

启动服务主要通过Docker Compose进行，具体步骤涉及docker-compose.yml配置文件和命令行指令。

• 启动命令:

  docker-compose up
  

  或者指定环境（例如mainnet）:

  docker-compose -f docker-compose.mainnet.yaml up
  

• 主程序:

  实际的服务逻辑在ton-http-api目录下的相关Python文件中实现，但直接启动不需要用户操作，通过Docker容器管理。

3. 项目的配置文件介绍

配置方面，ton-http-api结合环境变量和可能的外部配置文件进行设置。

环境变量配置

• 通过configure.py生成的环境变量文件: 运行此脚本将依据你的选择生成必要的环境变量，这包括缓存配置(TON_API_CACHE_*)、Tonlib设置(TON_API_TONLIB_*)等。

DockerCompose中的配置

• docker-compose.yml: 内部可能包含了网络、服务依赖、环境变量等配置，允许你通过编辑该文件来改变服务的行为，比如指向不同的lite服务器配置文件路径。

特殊配置文件路径

• Lite Server Config: 默认配置文件路径在Docker环境下是private/mainnet.json，这是通过预设或自行下载到private目录下的。用户可以通过修改环境变量TON_API_TONLIB_LITESERVER_CONFIG指向自定义的配置。

关键配置参数示例:

• TON_API_CACHE_ENABLED: 控制是否启用Redis缓存。
• TON_API_TONLIB_CDLL_PATH: 手动编译的tonlibjson库路径，非标准场景使用。
• TON_API_LOGS_LEVEL: 定义日志详细程度。

以上就是toncenter/ton-http-api项目的基础架构概览、启动流程及关键配置元素介绍。正确配置并遵循这些指导，可以顺利部署并使用该项目提供的HTTP API服务。