pascal jsonrpc lite

Pascal JSON-RPC Lite

Parse и сериализуйте сообщения JSON-RPC2 в приложении Free-Pascal или Delphi. Repository GIT: https://github.com/r3code/pascal-jsonrpc-lite

Вдохновленный https://github.com/teambition/jsonrpc-lite.

Реализация спецификаций JSON-RPC 2.0

Установить

1. Скачать.
2. Извлекать.
3. Добавьте UJSONRPC.PAS в ваш проект или добавьте путь к UJSONRPC.PAS в LIB PATH.

 uses ujsonrpc;

API

Интерфейс: ijsonrpcmessage

Метод: ijsonrpcmessage.asjsonObject

Возвращает объект как IsuperObject Clonned Form Form Internal JSON-OBJECT.

Метод: ijsonrpcmessage.asjson (adent: boolean = false; Escape: boolean = true): string;

Возвращает представление объекта строки JSON.

Параметры:

• indent : {boolean} отступить в результате JSON
• escape : {Boolean} Escape Special Chars

Класс: tjsonrpcmessage

Метод класса: tjsonrpcmessage.request (id, метод, параметры)

Создает объект запроса JSON-RPC 2.0, возвращает объект iJsonRPCmessage. Осознает ijsonrpcmessage.

Параметры:

• id : {String | Integer}
• method : {String}
• params : {ijsonrpcmessage}

Пример:

 var requestObj: TJsonRpcMessage; 
requestObj := TJsonRpcMessage.Request( ' 123 ' , ' update ' , SO( ' {list: [1, 2, 3]} ' ));
writeln(requestObj.asString);
// {
//   jsonrpc: '2.0',
//   id: '123',
//   method: 'update',
//   params: {list: [1, 2, 3]}
// } 

Метод класса: tjsonrpcmessage.notification (Метод, Params)

Создает объект уведомления JSON-RPC 2.0, вернуть объект iJsonRpcMessage.

Параметры:

• method : {String}
• params : {ijsonrpcmessage}

Пример:

 var notificationObj: TJsonRpcMessage;
notificationObj := TJsonRpcMessage.notification( ' update ' , SO( ' {list: [1, 2, 3]} ' ));
writeln(notificationObj.asString);
// {
//   jsonrpc: '2.0',
//   method: 'update',
//   params: {list: [1, 2, 3]}
// } 

Метод класса: tjsonrpcmessage.success (id, результат)

Создает объект ответа на успех JSON-RPC 2.0, возвращает объект iJsonRpcMessage.

Параметры:

• id : {String | Integer}
• result : {ijsonrpcmessage}

Пример:

 var msg: TJsonRpcMessage;
msg := TJsonRpcMessage.success( ' 123 ' , ' OK ' );
writeln(msg.asString);
// {
//   jsonrpc: '2.0',
//   id: '123',
//   result: 'OK',
// } 

Метод класса: tjsonrpcmessage.error (id, ошибка)

Создает объект ответа на ошибку JSON-RPC 2.0, верните объект iJsonRPCmessage.

Параметры:

• id : {String | Integer}
• error : {ijsonrpcmessage} Используйте tjsonrpcerror или его братья и сестры

Пример:

 var msg: TJsonRpcMessage;
msg := TJsonRpcMessage.Error( ' 123 ' , TJsonRpcError.Create(- 32000 , ' some error ' , ' blabla ' ));
writeln(msg.asString);
// {
//   jsonrpc: '2.0',
//   id: '123',
//   error: {code: -32000, 'message': 'some error', data: 'blabla'},
// } 

Метод класса: tjsonrpcmessage.parse (s)

Принимает полезную нагрузку (строка) JSON-RPC 2.0 и пытается разобрать ее в JSON. В случае успеха, определите, какой это объект (ответ, уведомление, успех, ошибка или недействительная) и верните его тип и правильно отформатированный объект.

Параметры:

• s : {String}

Возвращает объект {ijsonrpcparsed}.

Enum: tjsonrpcobjecttype

Показывает тип сообщения, обнаруженного во время Parse. Типы: jotinvalid, Jotrequest, Jotnotification, Jotsuccess, Joterror.

Интерфейс: ijsonrpcparsed

Метод: ijsonrpcparsed.getMessageType

Возвращает один из <{jsonrpcobjecttype}.

Метод: ijsonrpcparsed.getmessagepayload

Возвращает сохраненный реф в ijsonrpcmessage.

Класс: tjsonrpcparsed

Осознает интерфейс ijsonrpcparsed.

Конструктор: tjsonrpcparsed.create (objtype, полезная нагрузка)

Создайте экземпляр TJSonRpCparsed.

Параметры:

• objType : {tjsonrpcobjecttype} Тип формата сообщения
• payload : {ijsonrpcmessage} тело сообщения

Класс: TJSONRPCERROR

Описывает объект ошибки JSON-RPC 2.0. Осознает интерфейс ijsonrpcmessage.

Конструктор: tjsonrpcerror.create (code, message [, data])

Создайте экземпляр TJSonRPCerror.

Параметры:

• code : {integer}
• message : {String}
• data : {String | isuperObject | nil} Необязательно

Примеры:

 var error: TJsonRpcError;
error =  TJsonRpcError.Create(- 32651 , ' some error ' , ' some data ' );

или

 var error: TJsonRpcError;
error =  TJsonRpcError.Create(- 32651 , ' some error ' , SO( ' { a: 1, extra: "some data"} ' ));

Метод класса: tjsonrpcerror.invalidrequest (data)

Create {tjsonrpcerror} объект с кодом ошибки -32600.

Параметры:

• data : {String | isuperObject | nil} - дополнительные данные

Метод класса: tjsonrpcerror.methodnotfound (data)

Create {tjsonrpcerror} объект с кодом ошибки -32601.

Параметры:

• data : {String | isuperObject | nil} - дополнительные данные

Метод класса: tjsonrpcerror.invalidparams (data)

Create {tjsonrpcerror} объект с кодом ошибки -32602.

Параметры:

• data : {String | isuperObject | nil} - дополнительные данные

Метод класса: tjsonrpcerror.internalerror (data)

Create {tjsonrpcerror} объект с кодом ошибки -32603.

Параметры:

• data : {String | isuperObject | nil} - дополнительные данные

Метод класса: tjsonrpcerror.parseerror (data)

Create {tjsonrpcerror} объект с кодом ошибки -32700.

Параметры:

• data : {String} - текст ошибки