Commit 78475197 authored by 张振华's avatar 张振华

Update 接口文档与代码对比工具说明.md

parent 7b4bb24a
## 1 工具需要做的配置及使用 ## 1 工具需要做的配置及使用
...@@ -242,14 +242,14 @@ json ...@@ -242,14 +242,14 @@ json
从chain33的工程代码中,找到接口定义: 从chain33的工程代码中,找到接口定义:
func (c *Chain33) SignRawTx(in *types.ReqSignRawTx, result *interface{}) error func (c *Chain33) SignRawTx(in *types.ReqSignRawTx, result *interface{}) error
其中,请求参数ReqSignRawTx定义在types包中,所以,如下关键字指明包路径: 其中,请求参数ReqSignRawTx定义在types包中,所以,如下关键字指明包路径:
**请求报文[types/ReqSignRawTx]:** **请求报文<!--[types/ReqSignRawTx]-->:**
响应消息是简单的string类型,可以不用检测(不需要在关键字“响应报文”后增加类似“[types/ReqSignRawTx]”的信息)。 响应消息是简单的string类型,可以不用检测(不需要在关键字“响应报文”后增加类似“[types/ReqSignRawTx]”的信息)。
2.接口消息为plugin中的具体的包中的消息 2.接口消息为plugin中的具体的包中的消息
```json ```json
### 1.3 生成撤销创建token 的交易(未签名) CreateRawTokenRevokeTx ### 1.3 生成撤销创建token 的交易(未签名) CreateRawTokenRevokeTx
**请求报文[dapp/token/types/TokenRevokeCreate]:** **请求报文<!--[dapp/token/types/TokenRevokeCreate]-->:**
` ` `json ` ` `json
{ {
...@@ -303,14 +303,14 @@ Response: ...@@ -303,14 +303,14 @@ Response:
从plugin的工程代码中,找到接口定义: 从plugin的工程代码中,找到接口定义:
func (c *Jrpc) CreateRawTokenRevokeTx(param *tokenty.TokenRevokeCreate, result *interface{}) error func (c *Jrpc) CreateRawTokenRevokeTx(param *tokenty.TokenRevokeCreate, result *interface{}) error
其中,请求参数TokenRevokeCreate定义在dapp/token/types包中,所以,如下关键字指明其包路径: 其中,请求参数TokenRevokeCreate定义在dapp/token/types包中,所以,如下关键字指明其包路径:
**请求报文[dapp/token/types/TokenRevokeCreate]:** **请求报文<!--[dapp/token/types/TokenRevokeCreate]-->:**
响应消息是简单的string类型,可以不用检测(不需要在关键字“响应报文”后增加类似“[dapp/token/types/TokenRevokeCreate]”的信息)。 响应消息是简单的string类型,可以不用检测(不需要在关键字“响应报文”后增加类似“[dapp/token/types/TokenRevokeCreate]”的信息)。
3.接口消息为chain33中某个dapp的具体的包中的消息,Chain33.CreateTransaction接口中承载具体执行器的action信息 3.接口消息为chain33中某个dapp的具体的包中的消息,Chain33.CreateTransaction接口中承载具体执行器的action信息
```json ```json
### 1.1 添加/删除一个token-finisher CreateTransaction ### 1.1 添加/删除一个token-finisher CreateTransaction
**请求报文[types/ModifyConfig]:** **请求报文<!--[types/ModifyConfig]-->:**
` ` `json ` ` `json
{ {
"jsonrpc":"2.0", "jsonrpc":"2.0",
...@@ -368,7 +368,7 @@ payload携带的内容格式如下: ...@@ -368,7 +368,7 @@ payload携带的内容格式如下:
```json ```json
### 6.3 根据创建事件的用户地址和事件所处状态查询事件ID QueryEventIDsByAddrAndStatus ### 6.3 根据创建事件的用户地址和事件所处状态查询事件ID QueryEventIDsByAddrAndStatus
**请求报文[dapp/oracle/types/QueryEventID]** **请求报文<!--[dapp/oracle/types/QueryEventID]-->**
` ` `json ` ` `json
{ {
"id":int32, "id":int32,
...@@ -402,7 +402,7 @@ payload携带的内容格式如下: ...@@ -402,7 +402,7 @@ payload携带的内容格式如下:
|type|string|不填|事件的类型| |type|string|不填|事件的类型|
|eventID|string|视情况|事件ID,第一次查询为空,如果得到结果数量超过一页,将eventID设置为上次查询结果的最后一个id,从而查到下一页的数据| |eventID|string|视情况|事件ID,第一次查询为空,如果得到结果数量超过一页,将eventID设置为上次查询结果的最后一个id,从而查到下一页的数据|
**响应报文[dapp/oracle/types/ReplyEventIDs]** **响应报文<!--[dapp/oracle/types/ReplyEventIDs]-->**
` ` `json ` ` `json
{ {
"id":int32, "id":int32,
...@@ -424,15 +424,15 @@ payload携带的内容格式如下: ...@@ -424,15 +424,15 @@ payload携带的内容格式如下:
``` ```
从plugin的工程代码中,找到具体dapp/oracle中的QueryEventID消息定义, 从plugin的工程代码中,找到具体dapp/oracle中的QueryEventID消息定义,
请求参数QueryEventID定义在dapp/oracle/types/包中,所以,如下关键字指明其包路径: 请求参数QueryEventID定义在dapp/oracle/types/包中,所以,如下关键字指明其包路径:
**请求报文[dapp/oracle/types/QueryEventID]** **请求报文<!--[dapp/oracle/types/QueryEventID]-->**
响应消息是ReplyEventIDs结构类型,该类型定义在dapp/oracle/types/包中,所以,如下关键字知名其包路径: 响应消息是ReplyEventIDs结构类型,该类型定义在dapp/oracle/types/包中,所以,如下关键字知名其包路径:
**响应报文[dapp/oracle/types/ReplyEventIDs]** **响应报文<!--[dapp/oracle/types/ReplyEventIDs]-->**
## 4 重点强调 ## 4 重点强调
1.目前各个接口的请求消息已经做过统一修订,修改了很多字段缺失、类型描述错误、字段名称错误等问题,后续有新的接口或者接口变化时,请遵循上述要求,确保文档格式符合要求,这样检测工具可以正常工作。 1.目前各个接口的请求消息已经做过统一修订,修改了很多字段缺失、类型描述错误、字段名称错误等问题,后续有新的接口或者接口变化时,请遵循上述要求,确保文档格式符合要求,这样检测工具可以正常工作。
```json ```json
**请求报文[types/ModifyConfig]:** //严格按这个格式,[]中的内容按消息的实际所在包名及消息名进行拼接填写。 **请求报文<!--[types/ModifyConfig]-->:** //严格按这个格式,[]中的内容按消息的实际所在包名及消息名进行拼接填写。
` ` `json ` ` `json
{ {
...... ......
...@@ -455,7 +455,7 @@ payload携带的内容格式如下: ...@@ -455,7 +455,7 @@ payload携带的内容格式如下:
2.对于各个接口的响应消息,还存在较多的问题,需要每个负责人按要求整改响应消息的描述,使之格式一致,符合统一标准,使检测工具可以检测响应消息。 2.对于各个接口的响应消息,还存在较多的问题,需要每个负责人按要求整改响应消息的描述,使之格式一致,符合统一标准,使检测工具可以检测响应消息。
```json ```json
**响应报文[dapp/oracle/types/ReplyEventIDs]** //严格按照这个格式,[]中的内容按消息的实际所在包名及消息名进行拼接填写。 如果result为string类型,则不携带[]部分,不做检测。 **响应报文<!--[dapp/oracle/types/ReplyEventIDs]-->** //严格按照这个格式,[]中的内容按消息的实际所在包名及消息名进行拼接填写。 如果result为string类型,则不携带[]部分,不做检测。
` ` `json ` ` `json
{ {
"id":int32, "id":int32,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment