My Restaurant API Document

[EDMTDEV] MY RESTAURANT API
MY RESTAURANT API DOCUMENT

Author : eddydn aka LinhNTH
Version : 1.0
Last Update: 05/26/2019
YouTube: https://wWw.youtube.com/eddydn71
EDDYDN@GMAIL.COM 1
EDDYDN@GMAIL.COM 2
EDDYDN@GMAIL.COM 3
I. Introduction
This document is a document of the specification of the My Restaurant
project, a project of a long series of lectures designed to support food ordering from
a variety of combined restaurants.
All assets and documents used in the project are provided free of charge
by EddyDn in the teaching process. Any details can be tracked at
wWw.youtube.com/eddydn71
MyRestaurant project is a passionate project of EddyDn, built for the series
of mobile application development series on Android operating system, through this
series you will learn how:
- Write Backend with NodeJS (support MSSQL or MySQL)
- Write Frontend with Android Studio (Maybe have Kotlin version)
Main features of the application
- Splash Screen
- Login / Logout with Facebook Account Kit
- View multiple restaurant
- Search nearby restaurant on MAP (support by Backend)
- Multiple categories
- Category can be dynamic change for any restaurant
- Multiple foods
- Food can be dynamic change for any Category
- Room persistence + RxJava use for Cart (client save)
- Retrofit + RxJava use for API request
- Support Online Payment (Braintree)
- Each Restaurant can be have each Payment gateway
- API support both MySQL and MSSQL
- Notification between Client / Restaurant App
- Each restaurant will have each account to manager
- Food can be have size , addon
EDDYDN@GMAIL.COM 4
Software Requirements:
a. Backend NodeJS + MSSQL
- Microsoft SQL Server 2017
- Microsoft SQL Server Management 18.0 (If you want to work with
- Visual Studio 2019 (NodeJS development)
- Android Studio 3.4.1 (latest)
b. Backend NodeJS + MySQL

- XAMPP 7.3.5
- Visual Studio 2019 (NodeJS development)
- Android Studio 3.4 (latest)
EDDYDN@GMAIL.COM 5
I. Database
In this version , I will show you my own first design of Database
EDDYDN@GMAIL.COM 6
a. User
This table will contain basic information about the user
MSSQL
MySQL
EDDYDN@GMAIL.COM 7
b. Restaurant
This table will contain basic information about the restaurant ,
‘UserOwner’ is Id of RestaurantOwner user . This will help
restaurant can be manage by multiple user
MSSQL
MySQL
EDDYDN@GMAIL.COM 8
c. RestaurantOwner
This table will contain user , but this user owner restaurant or is
staff of restaurant
MSSQL
MySQL
EDDYDN@GMAIL.COM 9
d. Menu
This table will contain all information about Menu
MSSQL
MySQL
EDDYDN@GMAIL.COM 10
e. Food
This table will contain all information of Food
MSSQL
MySQL
EDDYDN@GMAIL.COM 11
f. Menu_Food
This table will help us can create multiple food for multiple menu
MSSQL
MySQL
g. Restaurant_Menu
This table will help us can create multiple menu for multiple
restaurant
MSSQL
MySQL
EDDYDN@GMAIL.COM 12
h. Size
This table will contain size of food (Some food have size like
Pizza)
MSSQL
MySQL
EDDYDN@GMAIL.COM 13
i. Addon
This table will contain addon of food (Some food can be choose
addon like Pizza with special sauce)
MSSQL
MySQL
EDDYDN@GMAIL.COM 14
j. Food_Size
This table will help food can be multiple size
MSSQL
MySQL
k. Food_Addon
This table will help food can be multiple addon
MSSQL
MySQL
EDDYDN@GMAIL.COM 15
l. Order
This table will contain all information about order of user
MSSQL
MySQL
EDDYDN@GMAIL.COM 16
m. OrderDetail
This table will contain all detail of order
MSSQL
MySQL
EDDYDN@GMAIL.COM 17
n. Favorite
This table will contain all information about Food Favorite of User
MSSQL
MySQL
EDDYDN@GMAIL.COM 18
II. API Document

All API need request to :
http://localhost:3000 => Main Endpoint on Computer
http://10.0.2.2:3000 => Main Endpoint on Emulator Android
Tool use for test:

- Google Chrome (Web Browser)
- AdvancedRestClient (Chrome Exentions)
- Postman (option)
GET ALL USER
Endpoin Method Query Body

t
/user GET key
fbid
Example: http://localhost:3000/user?key=YOUR_API_KEY&userPh
one=%2b0988888888
Error:
- {"success":false,"message":"Wrong API","result":null}
Reason: Missing key (API key) in query
- {"success":false,"message":"Missing user_phone query in

url"}
Reason: Missing fbid in query
- {"success":false,"message":"…"}
Reason: error from server
Result:
- {"success":true,"result":[{"userPhone":"+84988353682","
name":"Eddy","address":"123444"}]}
- {"success":false,"message":"Empty"}
EDDYDN@GMAIL.COM 19
Example use in Advanced Rest Client
EDDYDN@GMAIL.COM 20
GET ALL RESTAURANT
Endpoint Method Query Body

/restaurant GET key
Example: http://localhost:3000/restaurant?key=YOUR_API_KEY
Error:
Result:
- {"success":true,"result…}]}
EDDYDN@GMAIL.COM 21
GET ALL RESTAURANT BY ID

/restaurant GET Key
ById restaurantId
Example: http://localhost:3000/restaurantById?key=YOUR_API_K
EY&restaurantId=1
Error:
- {"success":false,"message":"Missing restaurantId field in

query","result":null}
Reason: Missing restaurantId in query
Result:
EDDYDN@GMAIL.COM 22
EDDYDN@GMAIL.COM 23
GET FAVORITES BY FBID
Endpoi Method Query Body

nt
/favorite GET Key
fbid
Example http://localhost:3000/favorite?key=YOUR_API_KEY&fbid
: =xxxx
Error:

Result:
EDDYDN@GMAIL.COM 24
Example use with Advanced Client
EDDYDN@GMAIL.COM 25
GET FAVORITES BY RESTAURANT

/favoriteByRes GET Key
taurant Fbid
restaurantId
Example: http://localhost:3000/
favoriteByRestaurant?key=YOUR_API_KEY&fbid=
xxxx&restaurantId=1
Error:
- {"success":false,"message":"Missing fbid field in

Result:
EDDYDN@GMAIL.COM 26
Example use with Advanced Rest Client
EDDYDN@GMAIL.COM 27
GET NEARBY RESTAURANT

/nearbyrestaurant GET Key
Lat
Lng
Distance
nearbyrestaurant?key=YOUR_API_KEY&lat=
30.328820&lng= -81.485750&distance=10
Error:
- {"success":false,"message":"Missing lat or lng field in

Reason: Missing key Lat or Lng in query
Result:
EDDYDN@GMAIL.COM 28
EDDYDN@GMAIL.COM 29
GET ALL MENU BY RESTAURANT

/menu GET Key
restaurantId
menu?key=YOUR_API_KEY& restaurantId=1
Error:

Reason: Missing key restaurantId in query
Result:
EDDYDN@GMAIL.COM 30
EDDYDN@GMAIL.COM 31
GET ALL FOOD BY MENU

/food GET Key
menuId
food?key=YOUR_API_KEY& menuId=1
Error:
- {"success":false,"message":"Missing menuId field in

Reason: Missing key menuId in query
Result:
EDDYDN@GMAIL.COM 32
EDDYDN@GMAIL.COM 33
GET FAVORITE BY USER

/favorite GET Key
fbid
restaurantId
food?key=YOUR_API_KEY&
fbid=xxx&restaurantId=1
Error:

Reason: Missing key foodName in query
Result:
EDDYDN@GMAIL.COM 34
EDDYDN@GMAIL.COM 35
GET LIST FAVORITE ID BY FBID AND RESTAURANT

/favoriteByRestaurant GET Key
fbid
restaurantId
food?key=YOUR_API_KEY&
fbid=xxx&restaurantId=1
Error:

Result:
EDDYDN@GMAIL.COM 36
EDDYDN@GMAIL.COM 37
SEARCH FOOD BY NAME

/searchfood GET Key
foodName
food?key=YOUR_API_KEY& menuId=1
Error:

Result:
EDDYDN@GMAIL.COM 38
EDDYDN@GMAIL.COM 39
GET FOOD BY ID

/foodById GET Key
foodId
food?key=YOUR_API_KEY& foodId=1
Error:
- {"success":false,"message":"Missing foodId field in

Reason: Missing key foodId in query
Result:
EDDYDN@GMAIL.COM 40
EDDYDN@GMAIL.COM 41
GET ALL SIZE BY FOOD

/size GET Key
foodId
Example: http://localhost:3000/ size?key=YOUR_API_KEY&
foodId =1
Error:

Result:
EDDYDN@GMAIL.COM 42
EDDYDN@GMAIL.COM 43
GET ALL ADDON BY FOOD

/addon GET Key
foodId
Example: http://localhost:3000/addon?key=YOUR_API_KEY&
foodId =1
Error:

Result:
EDDYDN@GMAIL.COM 44
EDDYDN@GMAIL.COM 45
GET ALL ORDER BY USER

/order GET Key
orderPhone
Example: http://localhost:3000/order?key=YOUR_API_KEY&
orderPhone =%2B988888888
Error:
- {"success":false,"message":"Missing orderPhone field in

Reason: Missing key orderPhone in query
Result:
EDDYDN@GMAIL.COM 46
EDDYDN@GMAIL.COM 47
GET ALL ORDER DETAIL BY ORDER

/orderdetail GET Key
orderId
orderdetail?key=YOUR_API_KEY& orderId =54
Error:
- {"success":false,"message":"Missing orderId field in

Reason: Missing key orderId in query
Result:
EDDYDN@GMAIL.COM 48
EDDYDN@GMAIL.COM 49
CREATE OR UPDATE USER

/user POST Key
userPhone
userName
userAddress
fbid
Example: http://localhost:3000/user
Error:
{"success":false,"message":"Missing userPhone
- field in query","result":null}
Reason: Missing key userPhone
in query
Result:
- {"success":true,"Success”}
EDDYDN@GMAIL.COM 50
EDDYDN@GMAIL.COM 51
CREATE NEW ORDER NUMBER BY USER

/createOrder POST Key
orderFBID
orderPhone
orderName
orderAddress
orderDate
restaurantId
transactionId
cod
totalPrice
numOfItem
Example: http://localhost:3000/ createOrder
Error:
- {"success":false,"message":"Missing orderPhone field in

Reason: Missing key orderPhone in query
Result:
EDDYDN@GMAIL.COM 52
If COD = 1 (TRUE) , so we can don’t care about TransactionId , we can put it

NONE
If COD = 0 (FALSE) , we must add transactionId , transactionId will return from
Braintree when you make payment in app
EDDYDN@GMAIL.COM 53
ADD ORDER DETAIL FOR ORDER

/updateOrder POST Key
orderId
orderDetail
Example: http://localhost:3000/ updateOrder
Error:
{"success":false,"message":"Missing orderId
Reason: Missing key orderId
in query
Result:
EDDYDN@GMAIL.COM 54
#Note: orderDetail field is an JSON object of all detail of Information

In this example I use :
[{"foodAddon":"[{\"extraPrice\":5.0,\"id\":2,\"name\":\"Special Sauce
02\"},{\"extraPrice\":5.0,\"id\":3,\"name\":\"Special Sauce
03\"}]","foodExtraPrice":14.0,"foodId":39,"foodImage":"http://10.0.2.2:3000/21_
mushroom_pizza.jpg","foodName":"MUSHROOM
PIZZA","foodPrice":25.0,"foodQuantity":2,"foodSize":"Large","restaurantId":1,"
userPhone":"+84988353682"}]
Parse it by JSON to understandable
EDDYDN@GMAIL.COM 55
EDDYDN@GMAIL.COM 56
CREATE NEW FAVORITE

/favorite POST Key
fbid
foodId
restaurantId
restaurantName
foodName
foodImage
price
Example: http://localhost:3000/ createOrder

Error:
{"success":false,"message":"Missing fbid field in query","result":null}

Reason: Missing key fbid in query
Result:
EDDYDN@GMAIL.COM 57
EDDYDN@GMAIL.COM 58
DELETE Favorite
Endpoi Method Query Body

nt
/favorit DELETE Key
e fbid
foodId
restaurantId
Exampl http://localhost:3000/favorite?key=xxx&fbid=xxx&foodId=1
e: &restaurantId=1
Error:
{"success":false,"message":"Missing orderId
Reason: Missing key orderId
in query
Result:
EDDYDN@GMAIL.COM 59
EDDYDN@GMAIL.COM 60

My Restaurant API Document

Загружено:

Сведения о документе

Исходное описание:

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

My Restaurant API Document

Загружено:

Авторское право:

Доступные форматы

[EDMTDEV] MY RESTAURANT API

MY RESTAURANT API DOCUMENT

b. Backend NodeJS + MySQL

II. API Document

Tool use for test:

GET ALL USER

Endpoin Method Query Body

- {"success":false,"message":"Missing user_phone query in

Example use in Advanced Rest Client

GET ALL RESTAURANT

Endpoint Method Query Body

Example use in Advanced Rest Client

GET ALL RESTAURANT BY ID

Endpoint Method Query Body

- {"success":false,"message":"Missing restaurantId field in

Example use in Advanced Rest Client

GET FAVORITES BY FBID

Endpoi Method Query Body

- {"success":false,"message":"Missing restaurantId field in

Example use with Advanced Client

GET FAVORITES BY RESTAURANT

Endpoint Method Query Body

- {"success":false,"message":"Missing fbid field in

Example use with Advanced Rest Client

GET NEARBY RESTAURANT

Endpoint Method Query Body

- {"success":false,"message":"Missing lat or lng field in

Example use in Advanced Rest Client

GET ALL MENU BY RESTAURANT

Endpoint Method Query Body

- {"success":false,"message":"Missing restaurantId field in

Example use in Advanced Rest Client

GET ALL FOOD BY MENU

Endpoint Method Query Body

- {"success":false,"message":"Missing menuId field in

Example use in Advanced Rest Client

GET FAVORITE BY USER

Endpoint Method Query Body

- {"success":false,"message":"Missing menuId field in

GET LIST FAVORITE ID BY FBID AND RESTAURANT

Endpoint Method Query Body

- {"success":false,"message":"Missing menuId field in

SEARCH FOOD BY NAME

Endpoint Method Query Body

- {"success":false,"message":"Missing menuId field in

Endpoint Method Query Body

- {"success":false,"message":"Missing foodId field in

GET ALL SIZE BY FOOD

Endpoint Method Query Body

- {"success":false,"message":"Missing foodId field in

Example use in Advanced Rest Client

GET ALL ADDON BY FOOD

Endpoint Method Query Body

- {"success":false,"message":"Missing foodId field in

Example use in Advanced Rest Client

GET ALL ORDER BY USER

Endpoint Method Query Body

- {"success":false,"message":"Missing orderPhone field in

Example use in Advanced Rest Client

GET ALL ORDER DETAIL BY ORDER

Endpoint Method Query Body

- {"success":false,"message":"Missing orderId field in

Example use in Advanced Rest Client