Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,4 @@ java-tron 节点对外暴露三套 API。它们底层能力大体一致,区别
- [HTTP 接口参考](http/index.md) —— `/wallet/*` 与 `/walletsolidity/*`(部分支持)下的端点,按功能模块组织
- [JSON-RPC 接口参考](json-rpc/index.md) —— `eth_*` / `net_*` / `web3_*` 方法以及 Tron 专属的 `buildTransaction`,按功能模块组织
- [gRPC 接口参考](rpc/index.md) —— `protocol.Wallet` / `protocol.WalletSolidity`(部分支持)方法,按功能模块组织
- [机器可读 API 定义](interface-definitions.md) —— HTTP 的 OpenAPI 定义以及 JSON-RPC 的 OpenRPC 定义
17 changes: 17 additions & 0 deletions docs/api/interface-definitions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# 机器可读 API 定义

本仓库发布机器可读 API 定义,便于工具集成、SDK 生成和 AI agent 使用:

| API 类型 | 格式 | 文件 |
|---|---|---|
| HTTP API | OpenAPI 3.1 | [`openapi.yaml`](openapi.yaml) |
| JSON-RPC API | OpenRPC 1.2.6 | [`openrpc.json`](openrpc.json) |

每个接口对应的片段也会保留,方便审阅:

| API 类型 | 片段目录 |
|---|---|
| HTTP API | [`specs/http/`](https://github.com/tronprotocol/documentation-zh/tree/master/docs/api/specs/http) |
| JSON-RPC API | [`specs/json-rpc/`](https://github.com/tronprotocol/documentation-zh/tree/master/docs/api/specs/json-rpc) |

发布的定义来自 java-tron API 行为,并附带指向相应人类可读 API 文档的链接。顶层 `openapi.yaml` 和 `openrpc.json` 由各接口片段汇总生成,方便工具直接消费一个标准文件。
10,419 changes: 10,419 additions & 0 deletions docs/api/openapi.yaml

Large diffs are not rendered by default.

Loading