pocketdb api

pocketdb-api

Handcrafted REST API สำหรับ pocketdb.js - wrapper ฐานข้อมูลพ็อกเก็ตสำหรับ 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 stringified ที่ถูกต้อง คาดว่าสตริง
/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 เท่านั้นยอมรับวิธีการ 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"
  }
}