json-rpc_2.0 规范
最后更新于：2022-04-02 03:09:25
[TOC]
> [规范](https://wiki.geekdream.com/Specification/json-rpc_2.0.html)
## 概述
SON-RPC是一个无状态且轻量级的远程过程调用(RPC)协议。 本规范主要定义了一些数据结构及其相关的处理规则。它允许运行在基于socket,http等诸多不同消息传输环境的同一进程中。其使用[JSON](http://www.json.org/)（[RFC 4627](http://www.ietf.org/rfc/rfc4627.txt)）作为数据格式。
## 请求对象
**jsonrpc**
> 指定JSON-RPC协议版本的字符串，必须准确写为“2.0”
**method**
> 包含所要调用方法名称的字符串，以rpc开头的方法名，用英文句号（U+002E or ASCII 46）连接的为预留给rpc内部的方法名及扩展名，且不能在其他地方使用。
**params**
> 调用方法所需要的结构化参数值，该成员参数可以被省略。
**id**
> 已建立客户端的唯一标识id，值必须包含一个字符串、数值或NULL空值。如果不包含该成员则被认定为是一个通知。该值一般不为NULL[\[1\]](https://wiki.geekdream.com/Specification/json-rpc_2.0.html#id1)，若为数值则不应该包含小数[\[2\]](https://wiki.geekdream.com/Specification/json-rpc_2.0.html#id2)。
## 响应对象
**jsonrpc**
> 指定JSON-RPC协议版本的字符串，必须准确写为“2.0”
**result**
> 该成员在成功时必须包含。
>
> 当调用方法引起错误时必须不包含该成员。
>
> 服务端中的被调用方法决定了该成员的值。
**error**
> 该成员在失败是必须包含。
>
> 当没有引起错误的时必须不包含该成员。
>
> 该成员参数值必须为5.1中定义的对象。
**id**
> 该成员必须包含。
>
> 该成员值必须于请求对象中的id成员值一致。
>
> 若在检查请求对象id时错误（例如参数错误或无效请求），则该值必须为空值。
响应对象必须包含result或error成员，但两个成员必须不能同时包含。
## 错误对象
**code**
> 使用数值表示该异常的错误类型。 必须为整数。
**message**
> 对该错误的简单描述字符串。 该描述应尽量限定在简短的一句话。
**data**
> 包含关于错误附加信息的基本类型或结构化类型。该成员可忽略。 该成员值由服务端定义（例如详细的错误信息，嵌套的错误等）。
\-32768至-32000为保留的预定义错误代码。
';