ahmedynah / QurbaTask

Restaurants Management API

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

QurbaTask

Restaurant API

Important Notes


.env

  • Please, create a .env file and create the following example:

    Constants and credentials
                        SERVER_HOSTNAME = "localhost" 
                        SERVER_PORT=8080  
                        DB_CONN_STRING=
                        DB_NAME= 
                        MONGO_USERNAME = 
                        MONGO_PASSWORD = 
                        MONGO_URL = 
    
  • NOTICE: Online mongo db is used, so you need to create a mongo database

    1. follow the link to create an online mongo db
  • You can test the end points using SwaggerUI

Images


figure 1

  • In figure 1, local development and port 8080 are selected and we choose to make the baseURL = /api/rest or /api/user from the dropdown meanu ( where the arrow points )
  • Some of the restaurant endpoints are shown

figure 2

  • Some of the user endpoints are shown

figure 3

  • Excuted /api/rest/get/all request to fetch all restaurants in database

figure 4

  • Excuted /api/user/get/all request to fetch all users in database

About

Restaurants Management API


Languages

Language:TypeScript 100.0%