pocketdb api

PocketDB-api

واجهة برمجة تطبيقات REST المصنوعة يدويًا لـ PocketDB.JS - غلاف قاعدة بيانات الجيب لـ Telegra.ph

 // GET https://pocketdb-api.vercel.app/get?token=my-token&key=users
{
  "success" : true ,
  "result" : {
    "list" : [ "users" ] ,
    "data" : [ {
      "name" : "John Doe" ,
      "age" : 24 ,
      "email" : "[email protected]"
    } ]
  } ,
  "request" : {
    "endpoint" : "/get" ,
    "token" : "my-token" ,
    "key" : "users"
  }
}

جربه عبر الإنترنت

يقدم pocketdb-api استخدامًا عبر الإنترنت على /web/index.html

نقاط النهاية

نقطة النهاية	طريقة	حدود
/set	بريد	مفتاح ، *الرمز المميز
/get	يحصل	مفتاح ، رمز

* - خياري

الوثائق

/set مع الرمز المميز

 POST https://pocketdb-api.vercel.app/set?token=...&key=...

عند استخدام /set مع رمز رمزي ، سيقوم بتعديل أو إنشاء بيانات مرتبطة بالمفتاح المحدد ، باستخدام محتوى JSON المتوفر في هيئة الطلب.

 await fetch ( "https://pocketdb-api.vercel.app/set?token=...&key=users" , {
  method : "post" ,
  body : JSON . stringify ( {
    name : "John Doe" ,
    age : 24 ,
    email : "[email protected]"
  } )
} )

سيبدو الناتج هكذا:

 {
  "success" : true ,
  "result" : {
    "list" : [ "users" ]
  } ,
  "request" : {
  "endpoint" : "/set" ,
    "key" : "users" ,
    "value" : {
      "name" : "John Doe" ,
      "age" : 24 ,
      "email" : "[email protected]"
    } ,
    "token" : "..."
  }
} 

/set بدون رمز

 POST https://pocketdb-api.vercel.app/set?&key=...

عند استخدام /set بدون رمز ، سيبدأ قاعدة بيانات جديدة وإدراج البيانات المرتبطة بالمفتاح المقدم ، باستخدام محتوى JSON المتوفر في هيئة الطلب.

 await fetch ( "https://pocketdb-api.vercel.app/set?key=users" , {
  method : "post" ,
  body : JSON . stringify ( {
    name : "John Doe" ,
    age : 24 ,
    email : "[email protected]"
  } )
} )

سيبدو الناتج هكذا:

 {
  "success" : true ,
  "result" : {
    "list" : [ "users" ] ,
    "token" : "..."
  } ,
  "request" : {
    "endpoint" : "/set" ,
    "key" : "users" ,
    "value" : {
      "name" : "John Doe" ,
      "age" : 24 ,
      "email" : "[email protected]"
    }
  }
} 

/get

 GET https://pocketdb-api.vercel.app/get?token=...&key=...

تسترجع نقطة النهاية هذه محتوى البيانات المرتبط بالمفتاح المقدم ويعيده بتنسيق JSON.

 await fetch ( "https://pocketdb-api.vercel.app/get?token=...&key=users" )

سيبدو الناتج هكذا:

 {
  "success" : true ,
  "result" : {
    "list" : [ "users" ] ,
    "data" : {
      "name" : "John Doe" ,
      "age" : 24 ,
      "email" : "[email protected]"
    }
  } ,
  "request" : {
    "endpoint" : "/get" ,
    "key" : "users" ,
    "token" : "..."
  }
} 

الأخطاء

نقطة النهاية	خطأ	رسالة	سبب
/set	INCOMPLETE_PARAM	المعلمات غير المكتملة. يرجى عرض الوثائق https://github.com/creuserr/pocketdb-api/blob/main/readme.md#documentation لمزيد من المعلومات.	key المعلمة مطلوب. وكذلك الجسم مثل json.
/set	INVALID_BODY	لا يتم ترميز الجسم بشكل صحيح. يرجى عرض الوثائق https://github.com/creuserr/pocketdb-api/blob/main/readme.md#documentation لمزيد من المعلومات.	يجب أن يكون الجسم JSON صحيح. من المتوقع سلسلة
/set	INVALID_METHOD	المنشور هو الطريقة الوحيدة المقبولة لنقطة النهاية /المجموعة	تقبل نقطة النهاية /set فقط طريقة POST .
/get	INCOMPLETE_PARAM	المعلمات غير المكتملة. يرجى عرض الوثائق https://github.com/creuserr/pocketdb-api/blob/main/readme.md#documentation لمزيد من المعلومات.	key المعلمات token مطلوب.
/get	INVALID_METHOD	الحصول على الطريقة الوحيدة المقبولة لنقطة النهاية /الحصول عليها	نقطة النهاية /get تقبل فقط طريقة GET .
/set أو /get	INTERNAL_ERROR	رسالة الخطأ	قد يختلف هذا الخطأ اعتمادًا على الخطأ الذي تم رفعه. تتضمن الأسباب المحتملة JSON غير صالحة ، وفشل الاتصال ، أو قاعدة البيانات غير موجودة (الرمز المميز غير موجود) ، أو لم يتم العثور على المفتاح.

 // Example Error:
// POST https://pocketdb-api.vercel.app/get?token=...&key=...

{
  "success" : false ,
  "error" : "INVALID_METHOD" ,
  "message" : "GET is the only method accepted for the endpoint /get" ,
  "request" : {
    "token" : "..." ,
    "key" : "..." ,
    "endpoint" : "/get"
  }
}