Giter VIP home page Giter VIP logo

basic-book-crud-api's Introduction

Book Collection

Introduction

This repository contains a simple and efficient RESTful API built with Express.js and Mongoose, allowing you to perform basic CRUD (Create, Read, Update, Delete) operations on a collection of books.

Features

  • Create: Add new books to the collection with their Title(required), Author(required), Description(optional), PublishedYear(optional).
  • Read: Retrieve information about specific books or get a list of all books in the collection.
  • Update: Modify the details of existing books.
  • Delete: Remove books from the collection as needed.

Technologies Used

The API is built using the following technologies:

  • Express.js: A flexible and minimalist web application framework for Node.js, providing a robust set of features for web and mobile applications.
  • Mongoose: An Object Data Modeling (ODM) library for MongoDB and Node.js, simplifying the interaction with the MongoDB database.
  • MongoDB: A popular NoSQL database solution known for its scalability, flexibility, and ease of use.
  • RESTful Architecture: The API follows the principles of Representational State Transfer (REST), providing a standard and predictable way to interact with resources.

Getting Started

To get started with the Bookstore RESTful API, follow these steps:

  1. Clone the repository: git clone https://github.com/Hasib192/basic-book-crud-api.git
  2. Install the dependencies: cd basic-book-crud-api and run npm install
  3. Create an .env file in your project root folder and add your variables. See .env.example for assistance.
  4. Start the server: Run npm start to launch the API.
  5. You can now interact with the API endpoints using tools like Postman.

API Endpoints

HTTP Verbs Endpoints Action
POST /api/v1/books To create a new book ( Title(required), Author(required), Description(optional), PublishedYear(optional) )
GET /api/v1/books To retrieve all book
GET /api/v1/books/:id To retrieve details of a single book ( id(required), Title(required), Author(required), Description(optional), PublishedYear(optional) )
PUT /api/v1/books/:id To updated the details of a single book ( id(required), Title(required), Author(required), Description(optional), PublishedYear(optional) )
DELETE /api/v1/books/:id To delete a single book ( id(required) )

Authors

Hasib

basic-book-crud-api's People

Contributors

hasib192 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.