Delete API

Introduction

FrontQL is a lightweight front-end querying language designed to streamline client-server communication for web applications. It simplifies data deletion by allowing clients to send exactly what they need to the server. One of the key features of FrontQL is its DELETE API, which enables clients to delete data on the server using HTTP DELETE requests.

The DELETE API of FrontQL is based on a structured query language that is both powerful and easy to understand. When a client makes a DELETE request to a FrontQL-enabled server, it includes a query parameter that specifies the fields and objects to be deleted. The server then processes this query and deletes the requested data.

By using the DELETE API of FrontQL, developers can reduce the amount of data transferred over the network, minimize the need for multiple API endpoints, and ensure that applications are more performant and scalable.

Example

Here’s a simple example of a FrontQL DELETE API request:

API
Fetch

async function deleteUser() {
  const response = await Api.delete("/users/1");

  return response;
}

async function deleteUser() {
  const url = `${BASE_URL}/users/1`; // Replace BASE_URL with the base URL of API server
  const response = await fetch(url, {
    method: "DELETE",
    headers: {
      "Content-Type": "application/json",
      app: DATABASE, // Replace DATABASE with the name of your database
      token: TOKEN, // Replace TOKEN with the token
      // OR
      // Authorization: `Bearer ${AUTH_TOKEN}`, // Replace AUTH_TOKEN with the authorization token,
    }
  })

  const data = await response.json();
  return data;
}

Output

This example deletes the user with ID 1 from the server.

{
  "err": false,
  "result": {
    "lastDeletedID": 1,
    "affectedRows": 1
  }
}

Multiple Deletes

It is possible to delete multiple objects in a single request.
Simply passing an array of objects to the body parameter is enough.
The id field is required in each object.
Example:

API
Fetch

async function deleteUsers() {
  const response = await Api.delete("/users", {
    body: [{ id: 1 }, { id: 2 }],
  });

  return response;
}

async function deleteUsers() {
  const url = `${BASE_URL}/users`; // Replace BASE_URL with the base URL of API server
  const response = await fetch(url, {
    method: "DELETE",
    headers: {
      "Content-Type": "application/json",
      app: DATABASE, // Replace DATABASE with the name of your database
      token: TOKEN, // Replace TOKEN with the token
      // OR
      // Authorization: `Bearer ${AUTH_TOKEN}`, // Replace AUTH_TOKEN with the authorization token,
    },
    body: JSON.stringify([
        { id: 1 },
        { id: 2 },
    ])
  })

  const data = await response.json();
  return data;
}