Edu CRUD API 📚

Introduction

Edu CRUD API is a basic CRUD (Create, Read, Update, Delete) API built with Express.js. It is designed as an educational tool to help developers learn about building APIs, using Node.js, handling requests, and managing data with basic CRUD operations.

Installation

To install the Edu CRUD API package, run the following command:

1npm install edu-crud-api

Usage

Here's a basic example of how to use the Edu CRUD API in your Node.js project:

Step 1: Require and Set Up the API

1const express = require('express');
2const app = express();
3const eduCrudApi = require('edu-crud-api');
4
5app.use(express.json());
6app.use(eduCrudApi);
7
8const PORT = process.env.PORT || 3000;
9app.listen(PORT, () => {
10  console.log(`Server is running on port ${PORT}`);
11});

Step 2: Define Your Routes

Edu CRUD API provides predefined routes for CRUD operations. You can use them as follows:

• GET /items - Retrieves a list of all items.
• GET /items/:id - Retrieves a single item by its ID.
• POST /items - Creates a new item.
• PUT /items/:id - Updates an existing item by its ID.
• PATCH /items/:id - Partially updates an item by its ID.
• DELETE /items/:id - Deletes an item by its ID.
• HEAD /items/:id - Checks if an item exists by its ID.

Example Endpoints

🏠 Welcome Message

Endpoint: /
Method: GET
Description: Returns a welcome message.

Response:

Welcome to the CRUD API!

📜 Get All Items

Endpoint: /items
Method: GET
Description: Retrieves a list of all items.

Response:

1[
2  {
3    "id": "unique-id-1",
4    "Learn": "Item 1"
5  },
6  {
7    "id": "unique-id-2",
8    "Learn": "Item 2"
9  }
10]

🔍 Get Single Item

Endpoint: /items/:id
Method: GET
Description: Retrieves a single item by its ID.

Response:

1{
2  "id": "unique-id-1",
3  "Learn": "Item 1"
4}

➕ Create Item

Endpoint: /items
Method: POST
Description: Creates a new item.

Request Body:

1{
2  "Learn": "New Item"
3}

Response:

1{
2  "id": "new-unique-id",
3  "Learn": "New Item"
4}

🔄 Update Item

Endpoint: /items/:id
Method: PUT
Description: Updates an existing item by its ID.

Request Body:

1{
2  "Learn": "Updated Item"
3}

Response:

1{
2  "id": "unique-id-1",
3  "Learn": "Updated Item"
4}

⚙️ Partially Update Item

Endpoint: /items/:id
Method: PATCH
Description: Partially updates an item by its ID.

Request Body:

1{
2  "Learn": "Partially Updated Item"
3}

Response:

1{
2  "id": "unique-id-1",
3  "Learn": "Partially Updated Item"
4}

❌ Delete Item

Endpoint: /items/:id
Method: DELETE
Description: Deletes an item by its ID.

Response:

Status: 204 No Content

🔎 Check Item Existence

Endpoint: /items/:id
Method: HEAD
Description: Checks if an item exists by its ID.

Response:

Status: 200 OK (if exists) or 404 Not Found (if not exists)

Error Handling

If an item is not found or a bad request is made, the API will respond with an appropriate HTTP status code and message.

Example Error Response

1{
2  "error": "Item not found"
3}

Features

• 🔑 UUID: Uses UUIDs for unique item identification.
• Error Handling: Responds appropriately if an item is not found.

License

This project is licensed under the MIT License.

Repository

You can find the repository here. You can clone the repository via git clone https://github.com/Experiencedeveloper/Edu-CRUD-API