pocketdb api

Pocketdb-api

API REST artesanal para Pocketdb.js - Pocket Database Wrapper para 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"
  }
}

Experimente online

pocketdb-api oferece uso on-line em /web/index.html

Pontos de extremidade

Endpoint	Método	Parâmetros
/set	PUBLICAR	chave, *token
/get	PEGAR	chave, token

* - opcional

Documentação

/set com token

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

Ao utilizar /set com um token, ele modificará ou criará dados associados à chave especificada, usando o conteúdo JSON fornecido no corpo da solicitação.

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

A saída seria assim:

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

/set sem token

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

Ao usar /set sem um token, ele iniciará um novo banco de dados e inserirá dados associados à chave fornecida, usando o conteúdo JSON fornecido no corpo da solicitação.

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

A saída seria assim:

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

Esse endpoint recupera o conteúdo de dados associado à chave fornecida e o retorna no formato JSON.

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

A saída seria assim:

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

Erros

Endpoint	Erro	Mensagem	Causa
/set	INCOMPLETE_PARAM	Parâmetros incompletos. Veja a documentação https://github.com/creuserr/pocketdb-api/blob/main/readme.md#documentation para obter mais informações.	A key do parâmetro é necessária. Bem como o corpo como json.
/set	INVALID_BODY	O corpo não é adequadamente codificado. Veja a documentação https://github.com/creuserr/pocketdb-api/blob/main/readme.md#documentation para obter mais informações.	O corpo deve ser um json straciificado válido. String é esperada
/set	INVALID_METHOD	POST é o único método aceito para o endpoint /conjunto	O endpoint /set aceita apenas o método POST .
/get	INCOMPLETE_PARAM	Parâmetros incompletos. Veja a documentação https://github.com/creuserr/pocketdb-api/blob/main/readme.md#documentation para obter mais informações.	A key dos parâmetros e token são necessários.
/get	INVALID_METHOD	Obtenha é o único método aceito para o endpoint /obtenha	O terminal /get aceita apenas o método GET .
/set ou /get	INTERNAL_ERROR	Mensagem de erro	Este erro pode variar dependendo do erro elevado. As possíveis causas incluem JSON inválido, falha de conexão, banco de dados não encontrado (o token não existe) ou a chave não encontrada.

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