Giter VIP home page Giter VIP logo

9ijakids's Introduction

REST_API

This is an api for demonstrating some CRUD operations


Built with

  • Nodejs
  • Express.js
  • Mongodb
  • Javascript

Links


Requirements

Project Requirements 1. Users should be able to create, read, update amd delete user.

Setup

  • Install NodeJS, mongodb
  • pull this repo
  • update config.env
  • run npm run dev

Base URL

Models


User

field data_type constraints
email string required
firstname string required
lastname string required
phonenumber number false

APIs


Create User

  • Route: /api/v1/users/new-user
  • Method: POST
  • Body:
{
  "email": "[email protected]",
  "firstname": "jon",
  "lastname": "doe",
  "phonenumber: "090456875765"
}
  • Responses

    • Success
{
    status: "success"
    message: 'User created successful',
    "user": {
        "email": "[email protected]",
        "firstname": "jon",
        "lastname": "doe",
        "phonemumber": "12345f678"
       }
    }
}
  • error
{
    status: "error",
    message: 'error message',
}

  • error
{
  "status": "error",
  "message": error message,
}


Read Single User

  • Route: /api/v1/users
  • Method: POST
  • Body:
{
  "email": "[email protected]"
}
  • Responses

    • Success
{
    status: "success"
    message: 'User Found successful',
    "user": {
        "email": "[email protected]",
        "firstname": "jon",
        "lastname": "doe",
        "phonemumber": "12345f678"
       }
    }
}
  • error
{
    status: "error",
    message: 'error message',
}

Read All Users

  • Route: /api/v1/users
  • Method: GET
  • Body:

- Responses

  - Success

{ status: "success" Results: 1 message: 'Users, "user": { "email": "[email protected]", "firstname": "jon", "lastname": "doe", "phonemumber": "12345f678" } } }


- error

{ status: "error", message: 'error message', }


---

### Update User

- Route: /api/v1/users/<userID>
- Method: PATCH
- Body:

{ "lastname": "doe", "phonenumber: "090456875765" }


- Responses

  - Success

{ status: "success" message: 'User Updated sful', "user": { "email": "[email protected]", "firstname": "jon", "lastname": "doe", "phonemumber": "12345f678" } } }


- error

{ status: "error", message: 'error message', }


---



### Delete User

- Route: /api/v1/users/<userID>
- Method: DELETE
- Body:


- Responses

  - Success

{ status: "success" message: 'Successful "user": { null } } }


- error

{ status: "error", message: 'error message', }


---





...

Contributor

  • Kelechi Okoronkwo(Blakcoder)

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.