Skip to content

接口约定

linj edited this page Nov 23, 2022 · 1 revision

1 接口约定

[TOC]

  • 所有RPC接口均为HTTP协议;
  • 报文传递的均为JSON格式数据;
  • 本系统的RPC接口均为POST方法请求;

1.1 Request 格式

请求报文结构:

{
    "jsonrpc":"2.0",
    "id":int32,
    "method":"Chain33.Method",
    "params":[]
}

各参数说明:

参数 类型 是否必填 说明
id int32 接口 id 暂时不使用
method string rpc请求的方法名
params array 附加参数,默认为空

1.2 Response 格式

响应报文结构:

{
    "id":int32,
    "result":{},
    "error":null
}

各参数说明:

参数 类型 说明
id int32 和请求id对应
result string或json 返回的数据,不同方法返回的格式不同,纯string 或者 json格式数据
error string 出错时填写错误信息,无错时为空
Clone this wiki locally