Git Product home page Git Product logo

hng-stage-two's Introduction

HNG-Stage-Two

Simple REST API with Express.js and MongoDB

This is a simple REST API built with Express.js that performs CRUD operations on a "person" resource, using MongoDB as the database.

Prerequisites

Before you begin, ensure you have met the following requirements:

  • Node.js and npm installed on your machine.
  • MongoDB installed and running locally.

Setup

  1. Clone the repository:

    git clone https://github.com/JesusOfLagos/HNG-Stage-Two.git
  2. Navigate to the project directory:

    cd HNG-Stage-Two
    
    
  3. Install dependencies:

    npm install
    
    
  4. Start the server

    npm start
    
    
    

Endpoints

  1. Create a new Person:
    POST /api
    
    

a. Request Body:

   {
     "name": "John Doe"
   }

b. Response Body

{
  "id": "icidoi988988v9iu"
  "name": "John Doe"
}

  1. Get A Person By Id

    GET /api/:id
    
    
    

a. Response Body

{
  "name": "John Doe"
}

  1. Update A Person By Id

    PUT /api/:id
    
    
    

a. Request Body

{
  "name": "John Doe"
}

b. Response Body:

   {
     "message": "Person Updated Successfully"
   }
  1. Delete A Person By Id

    DELETE /api/:id
    
    
    

a. Response Body

{
  "message": "Person Deleted Successfully"
}

hng-stage-two's People

Contributors

jesusoflagos 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.