npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

edu-crud-api

v1.2.8

Published

A basic CRUD API built with Express. Ideal for educational purposes.

Downloads

1,266

Readme

Edu CRUD API 📚

npm npm npm npm install size

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:

npm 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

const express = require('express');
const app = express();
const eduCrudApi = require('edu-crud-api');

app.use(express.json());
app.use(eduCrudApi);

const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`Server is running on port ${PORT}`);
});

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:

[
  {
    "id": "unique-id-1",
    "Learn": "Item 1"
  },
  {
    "id": "unique-id-2",
    "Learn": "Item 2"
  }
]

🔍 Get Single Item

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

Response:

{
  "id": "unique-id-1",
  "Learn": "Item 1"
}

➕ Create Item

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

Request Body:

{
  "Learn": "New Item"
}

Response:

{
  "id": "new-unique-id",
  "Learn": "New Item"
}

🔄 Update Item

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

Request Body:

{
  "Learn": "Updated Item"
}

Response:

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

⚙️ Partially Update Item

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

Request Body:

{
  "Learn": "Partially Updated Item"
}

Response:

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

❌ 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

{
  "error": "Item not found"
}

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