pocketdb api

Pocketdb-Api

API Rest Rest Crafted для Pocketdb.js - Pocket Database Purper для 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 принимает только метод 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"
  }
}