{"info":{"_postman_id":"7fef50dc-437e-4aea-8161-59bf4f1c57a0","name":"RESTful API ( Signup , Login, Search, Update, Add Message, Read Messages ) with NodeJS and MySQL","description":"

GreetingsFromAuthor

\n

Name : Gaurav Raj Sinha

\n

GitHub : https://github.com/gauravgitgithub

\n

LinkedIn : https://linkedin.com/in/gauravrajsinha/

\n

Introduction

\n

What does your API do?\n This API is developed with NodeJS as backend and MySQL for Database. RESTful API is a way to communicate with the databases and interact with data by sending requests from URL with Body( Parameters ).

\n

This API has following features :

\n
    \n
  1. User Registration
    2. \n
  2. User Login
    3. \n
  3. User Profile Update
    4. \n
  4. User Search
    5. \n
  5. Sending Messages to User
    6. \n
  6. Reading messages for user ( unread, marked as read when read by user )
    7. \n
\n

Overview

\n

Language Used : JavaScript\nDatabase : MySQL\nCode Editor : VSCode\nApplication for testing APIs : POSTMAN

\n

Authentication

\n

What is the preferred way of using the API?

\n

1). For Registration: http://localhost:5000/api/signup\nParameters to be passed : first_name, last_name, email , phone, password

\n

2). For Login : http://localhost:5000/api/signin\nParameters to be passed : email, password

\n

3). For Updating Phone number : http://localhost:5000/api/update\nParameters to be passed : first_name, last_name, phone, newphone

\n

4). To Search for a specific user : http://localhost:5000/api/finduser\nParameters to be passed : first_name, last_name, phone, email

\n

5). To send message to a specific user : http://localhost:5000/api/addmessage\nParameters to be passed : email, message

\n

6). To read 'unread' messages : http://localhost:5000/api/readmessage\nParameters to be passed : email

\n

Error Codes

\n

What errors and status codes can a user expect?\nSucces : 200\nError : 404

\n

Rate limit

\n

Is there a limit to the number of requests an user can send?\nNo, there is no any limit for request count.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"GreetingsFromAuthor","slug":"greetingsfromauthor"},{"content":"Introduction","slug":"introduction"},{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"},{"content":"Rate limit","slug":"rate-limit"}],"owner":"6446110","collectionId":"7fef50dc-437e-4aea-8161-59bf4f1c57a0","publishedId":"Rztms9Fu","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-02-02T00:19:12.000Z"},"item":[{"name":"http://localhost:5000/api/signup","id":"9c4cd624-9b9f-424d-ac2a-337a1f9d153d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"http://localhost:5000/api/signup","description":"

For User Registration

\n","urlObject":{"protocol":"http","port":"5000","path":["api","signup"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"c0f054e7-9b0b-451b-89b5-f8329f04132d","name":"Default","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"http://localhost:5000/api/signup"},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"9c4cd624-9b9f-424d-ac2a-337a1f9d153d"},{"name":"http://localhost:5000/api/signin","id":"c33133ba-1017-4e9a-a1b0-f7c3d09d1313","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"http://localhost:5000/api/signin","description":"

For User Login

\n","urlObject":{"protocol":"http","port":"5000","path":["api","signin"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"49bb9dc7-30a6-4f4a-9c11-f21033d9cb48","name":"Default","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"http://localhost:5000/api/signin"},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c33133ba-1017-4e9a-a1b0-f7c3d09d1313"},{"name":"http://localhost:5000/api/update","id":"1b1a6165-7300-48a6-bf91-9f1c60aab336","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"http://localhost:5000/api/update","description":"

For Profile update

\n","urlObject":{"protocol":"http","port":"5000","path":["api","update"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"59ee97a1-80d6-45c4-85f5-fa45ed924552","name":"Default","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"http://localhost:5000/api/update"},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"1b1a6165-7300-48a6-bf91-9f1c60aab336"},{"name":"http://localhost:5000/api/finduser","id":"9bca4de1-166e-4d5a-97e3-968df49d99eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"http://localhost:5000/api/finduser","description":"

To Find a specific user

\n","urlObject":{"protocol":"http","port":"5000","path":["api","finduser"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"f0e5e347-89cb-4e06-8ffe-e5a4b141d496","name":"Default","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"http://localhost:5000/api/finduser"},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"9bca4de1-166e-4d5a-97e3-968df49d99eb"},{"name":"http://localhost:5000/api/addmessage","id":"e72aef4f-0296-4a9c-9cb9-8cc00c1034ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"http://localhost:5000/api/addmessage","description":"

To add message for a specific user

\n","urlObject":{"protocol":"http","port":"5000","path":["api","addmessage"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"d0e9bf39-e7cb-4a38-9624-d1f942db4356","name":"Default","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"http://localhost:5000/api/addmessage"},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e72aef4f-0296-4a9c-9cb9-8cc00c1034ac"},{"name":"http://localhost:5000/api/readmessage","id":"953d661e-da38-40a0-bb0d-64d0e8c8b636","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"http://localhost:5000/api/readmessage","description":"

To read Unread messages for user

\n","urlObject":{"protocol":"http","port":"5000","path":["api","readmessage"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"98040350-0987-4626-aabb-f2c2d549c80d","name":"Default","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"http://localhost:5000/api/readmessage"},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"953d661e-da38-40a0-bb0d-64d0e8c8b636"},{"name":"One Login - Get OTP","id":"51e08de7-928e-4f15-832d-4e5843a9f444","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"51e08de7-928e-4f15-832d-4e5843a9f444"}],"event":[{"listen":"prerequest","script":{"id":"5faff9c6-9d54-4ac7-bcae-d7102ae12e3f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9e149d83-dda2-4077-ab51-360a36391798","type":"text/javascript","exec":[""]}}]}