CRUD Operations

FREE
By Mahshooq Zubair | Updated 2달 전 | Database
Popularity

8.9 / 10

Latency

710ms

Service Level

99%

Health Check

100%

Back to All Tutorials (1)

Basic CRUD Operations

CRUD Operation API- Request Documentation

This document provides a basic guide on making requests to the CRUD Operation APIendpoints for performing CRUD (Create, Read, Update, Delete) operations on JSON data.

Created (POST Request with JSON Data)

To create a new JSON document, send a POST request to the API endpoint with the JSON data in the request body.

Endpoint: https://crud-operations2.p.rapidapi.com/api/v1

Request Method: POST

Request Body Example:

{
  "key1": "value1",
  "key2": "value2",
  ...
}

Get All (GET Request to Endpoint)

To retrieve all JSON documents, send a GET request to the API endpoint.

Endpoint: /documents

Request Method: GET

Get by ID (GET Request to Endpoint/ID)

To retrieve a specific JSON document by its ID, send a GET request to the API endpoint followed by the document ID.

Endpoint: https://crud-operations2.p.rapidapi.com/api/v1/{id}

Request Method: GET

Update (PATCH Requests to Endpoint/ID)

To update an existing JSON document, send a PATCH request to the API endpoint followed by the document ID, with the updated JSON data in the request body.

Endpoint: https://crud-operations2.p.rapidapi.com/api/v1/{id}

Request Method: PATCH

Request Body Example:

{
  "key1": "updated_value1",
  "key2": "updated_value2",
  ...
}

Delete (DELETE Requests to Endpoint/ID)

To delete a JSON document by its ID, send a DELETE request to the API endpoint followed by the document ID.

Endpoint: https://crud-operations2.p.rapidapi.com/api/v1/{id}

Request Method: DELETE


Note: Replace {id} with the actual ID of the document you want to interact with. Ensure proper error handling and authentication mechanisms are implemented as per your requirements.

This is a basic documentation to get started with making requests to the CRUD Operation APIendpoints. For detailed information on request parameters, error handling, and authentication, please refer to the API documentation.