pocketdb api

PocketDB-API

API istirahat buatan tangan untuk Pocketdb.js - Pembungkus basis data saku untuk 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"
  }
}

Cobalah secara online

pocketdb-api menawarkan penggunaan online di /web/index.html

Titik akhir

Titik akhir	Metode	Parameter
/set	POS	kunci, *token
/get	MENDAPATKAN	kunci, token

* - Opsional

Dokumentasi

/set dengan token

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

Saat menggunakan /set dengan token, itu akan memodifikasi atau membuat data yang terkait dengan kunci yang ditentukan, menggunakan konten JSON yang disediakan di badan permintaan.

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

Output akan terlihat seperti ini:

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

/set tanpa token

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

Saat menggunakan /set tanpa token, itu akan memulai database baru dan memasukkan data yang terkait dengan tombol yang disediakan, menggunakan konten JSON yang disediakan di badan permintaan.

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

Output akan terlihat seperti ini:

 {
  "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=...

Titik akhir ini mengambil konten data yang terkait dengan kunci yang disediakan dan mengembalikannya dalam format JSON.

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

Output akan terlihat seperti ini:

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

Kesalahan

Titik akhir	Kesalahan	Pesan	Menyebabkan
/set	INCOMPLETE_PARAM	Parameter yang tidak lengkap. Silakan lihat dokumentasi https://github.com/creuserr/pocketdb-api/blob/main/readme.md#documentation untuk informasi lebih lanjut.	key parameter diperlukan. Serta tubuh sebagai json.
/set	INVALID_BODY	Tubuh tidak dikodekan dengan benar. Silakan lihat dokumentasi https://github.com/creuserr/pocketdb-api/blob/main/readme.md#documentation untuk informasi lebih lanjut.	Tubuh harus menjadi JSON yang valid. String diharapkan
/set	INVALID_METHOD	Posting adalah satu -satunya metode yang diterima untuk titik akhir /set	Titik akhir /set hanya menerima metode POST .
/get	INCOMPLETE_PARAM	Parameter yang tidak lengkap. Silakan lihat dokumentasi https://github.com/creuserr/pocketdb-api/blob/main/readme.md#documentation untuk informasi lebih lanjut.	key parameter dan token diperlukan.
/get	INVALID_METHOD	Dapatkan adalah satu -satunya metode yang diterima untuk titik akhir /dapatkan	Titik akhir /get hanya menerima metode GET .
/set atau /get	INTERNAL_ERROR	Pesan kesalahan	Kesalahan ini dapat bervariasi tergantung pada kesalahan yang terangkat. Kemungkinan penyebab termasuk JSON yang tidak valid, kegagalan koneksi, database tidak ditemukan (token tidak ada), atau kunci yang tidak ditemukan.

 // 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"
  }
}