pascal jsonrpc lite

Pascal JSON-RPC Lite

แยกวิเคราะห์และทำให้เป็นอนุกรมข้อความ JSON-RPC2 ในแอปพลิเคชันฟรี-ปาสกาลหรือ Delphi Git Repository: 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

 uses ujsonrpc;

API

อินเตอร์เฟส: ijsonrpcmessage

วิธีการ: ijsonrpcmessage.asjsonobject

ส่งคืนวัตถุเป็นรูปแบบ isuperObject clonned ภายใน json-object

วิธี: ijsonrpcmessage.asjson (เยื้อง: บูลีน = เท็จ; หลบหนี: บูลีน = จริง): สตริง;

ส่งคืนการแสดงวัตถุสตริง JSON

params:

• indent : {boolean} intent ผลลัพธ์ json
• escape : {Boolean} Escape Special Chars

คลาส: tjsonrpcmessage

วิธีการเรียน: tjsonrpcmessage.request (id, วิธี, params)

สร้างวัตถุคำขอ JSON-RPC 2.0 ส่งคืนวัตถุ ijsonrpcmessage ตระหนักถึง ijsonrpcmessage

params:

• 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 (วิธีการพารามิเตอร์)

สร้างวัตถุการแจ้งเตือน JSON-RPC 2.0 ส่งคืนวัตถุ ijsonrpcmessage

params:

• 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

params:

• 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

params:

• 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)

ใช้ Payload JSON-RPC 2.0 (สตริง) และพยายามแยกวิเคราะห์เป็น JSON หากประสบความสำเร็จให้พิจารณาว่ามันคือวัตถุอะไร (การตอบสนองการแจ้งเตือนความสำเร็จข้อผิดพลาดหรือไม่ถูกต้อง) และส่งคืนประเภทของมันและการจัดรูปแบบวัตถุที่เหมาะสม

params:

• s : {String}

ส่งคืนวัตถุของ {ijsonrpcparsed}

enum: tjsonrpcobjecttype

แสดงประเภทของข้อความที่ตรวจพบระหว่างการแยกวิเคราะห์ ประเภท: jotinvalid, jotrequest, jotnotification, jotsuccess, joterror

อินเตอร์เฟส: ijsonrpcparsed

วิธีการ: ijsonrpcparsed.getMessageType

ส่งคืนหนึ่งใน <{jsonrpcobjectType}

วิธีการ: ijsonrpcparsed.getMessagePayload

ส่งคืน REF ที่เก็บไว้เป็น ijsonrpcmessage

คลาส: tjsonrpcparsed

ตระหนักถึงอินเตอร์เฟส ijsonrpcparsed

ตัวสร้าง: tjsonrpcparsed.create (objtype, payload)

สร้างอินสแตนซ์ tjsonrpcparsed

params:

• objType : {tjsonrpcobjectType} ประเภทข้อความประเภทข้อความ
• payload : {ijsonrpcmessage} ข้อความข้อความ

คลาส: tjsonrpcerror

อธิบายวัตถุข้อผิดพลาด JSON-RPC 2.0 ตระหนักถึงอินเตอร์เฟส ijsonrpcmessage

ตัวสร้าง: tjsonrpcerror.create (รหัส, ข้อความ [, ข้อมูล])

สร้างอินสแตนซ์ tjsonrpcerror

params:

• code : {จำนวนเต็ม}
• message : {สตริง}
• 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 (ข้อมูล)

สร้างวัตถุ {TJSONRPCERROR} ด้วยรหัสข้อผิดพลาด -32600

params:

• data : {String | isuperObject | nil} - ข้อมูลพิเศษ

วิธีการเรียน: tjsonrpcerror.methodnotfound (ข้อมูล)

สร้างวัตถุ {tjsonRpCerror} ด้วยรหัสข้อผิดพลาด -32601

params:

• data : {String | isuperObject | nil} - ข้อมูลพิเศษ

วิธีการเรียน: tjsonrpcerror.invalidparams (ข้อมูล)

สร้างวัตถุ {TJSONRPCERROR} ด้วยรหัสข้อผิดพลาด -32602

params:

• data : {String | isuperObject | nil} - ข้อมูลพิเศษ

วิธีการเรียน: TJSONRPCERROR.InternalError (ข้อมูล)

สร้างวัตถุ {tjsonRpCerror} ด้วยรหัสข้อผิดพลาด -32603

params:

• data : {String | isuperObject | nil} - ข้อมูลพิเศษ

วิธีการเรียน: TJSONRPCERROR.PARSEERROR (ข้อมูล)

สร้างวัตถุ {tjsonRpCerror} ด้วยรหัสข้อผิดพลาด -32700

params:

• data : {string} - ข้อความข้อผิดพลาด