-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.js
More file actions
260 lines (224 loc) · 6.12 KB
/
Copy pathindex.js
File metadata and controls
260 lines (224 loc) · 6.12 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
import express from 'express'
const app = express()
app.use(express.urlencoded())
const PORT = 4000
let PRODUCTS = [
{
"id": 1,
"title": "Product 1",
"price": "50",
"discount": "5"
},
{
"id": 2,
"title": "Product 2",
"price": "100",
"discount": "10"
},
{
"id": 3,
"title": "Product 3",
"price": "150",
"discount": "15"
}
]
let idCounter = 4
app.get('/', (req, res) => {
res.send('Welcome to our app :)')
})
// // Products
// // 1. READ - GET /products
app.get('/products', (req, res) => {
res.json({
status: 'SUCCESS',
data: PRODUCTS
})
})
// 2. CREATE - POST /products
app.post('/products', (req, res) => {
const { title, price, discount } = req.body
const newProduct = { id: idCounter++, title, price, discount }
PRODUCTS.push(newProduct)
res.status(201).json({
status: 'SUCCESS',
message: 'Product created'
})
})
// 3. UPDATE - PATCH /products/:id
app.patch('/products/:id', (req, res) => {
const { id } = req.params
const product = PRODUCTS.find(p => p.id == id)
if(!product) {
return res.status(404).json({
status: 'FAILED',
message: 'Product not found'
})
}
const { title, price, discount } = req.body
if(title)
product.title = title
if(price)
product.price = price
if(discount)
product.discount = discount
res.json({
status: 'SUCCESS',
message: 'Product updated'
})
})
// 4. DELETE - DELETE /products/:id
app.delete('/products/:id', (req, res) => {
const { id } = req.params
const product = PRODUCTS.find(p => p.id == id)
if(!product) {
return res.status(404).json({
status: 'FAILED',
message: 'Product not found'
})
}
PRODUCTS = PRODUCTS.filter(p => p.id != id)
res.json({
status: 'SUCCESS',
message: 'Product deleted'
})
})
/* --------------------------- */
// Query Parameters
// app.get('/products', (req, res) => {
// let products = [...PRODUCTS]
// const { minDiscount, budget } = req.query
// if(minDiscount) {
// products = products.filter(p => p.discount >= Number(minDiscount))
// }
// if(budget) {
// products = products.filter(p => p.price <= Number(budget))
// }
// res.json({
// status: 'SUCCESS',
// data: products
// })
// })
/* --------------------------- */
// Route Parameters
// app.get('/products/:id', (req, res) => {
// const { id } = req.params
// const product = PRODUCTS.find(p => p.id == id)
// if(!product) {
// return res.status(404).json({
// status: 'FAILED',
// message: 'Product not found'
// })
// }
// res.json({
// status: 'SUCCESS',
// data: product
// })
// })
/* --------------------------- */
// UPDATE - PUT /products/:id (Complete replacement)
// app.put('/products/:id', (req, res) => {
// const { id } = req.params
// const productIndex = PRODUCTS.findIndex(p => p.id == id)
// if(productIndex == -1) {
// return res.status(404).json({
// status: 'FAILED',
// message: 'Product not found'
// })
// }
// const { title, price, discount } = req.body
// PRODUCTS[productIndex] = { id, title, price, discount }
// res.json({
// status: 'SUCCESS',
// message: 'Product updated'
// })
// })
/* --------------------------- */
app.listen(PORT, () => {
console.log(`Server is running on http://localhost:${PORT}`)
})
/*
# REST
- REpresentational State Transfer
- A set of guidelines/principles for desigining APIs
- Introduced in 2000
- Makes APIs consistent and predictable
- APIs before REST
- There was no common standard
- Different developers designed APIs differently
- Examples:
- Fetch products from the server
- GET /getProducts
- GET /fetchProducts
- GET /listProducts
- Create a product
- POST /addProduct
- POST /createProduct
- POST /newProduct
- Problems:
- Difficult to understand
- Different naming conventions
- No consistency
- REST Principles:
1. Resource based URLs
- Resources are represented using nouns
- Examples:
- /products
- /users
- /orders
- Sub resources
- Add / followed by the sub resource
- Examples
- /products/10/reviews (Reviews of product with ID=10)
- /users/5/followers (Followers of user with ID=5)
2. Use HTTP Method
- CRUD operations: Create, Read, Update, Delete
- CRUD mapped to HTTP Methods
----------- -----------
HTTP METHOD CRUD OPERATION
----------- -----------
GET READ
POST CREATE
PATCH/PUT UPDATE
DELETE DELETE
- Examples of RESTful APIs:
- 'products' resource
- (READ) Fetch products from the server
- GET /products
- (Create) Create a product
- POST /products
- (Update) Update a product
- PATCH /products/:id
- (Delete) Delete a product
- DELETE /products/:id
- 'users' resource
- GET /users
- POST /users
- PATCH /users/:id
- DELETE /users/:id
- 'orders' resource
- GET /orders
- POST /orders
- PATCH /orders/:id
- DELETE /orders/:id
3. Stateless
- Every request is independent
- Server does not remember previous requests
- Query parameters
- Used to send optional information
- URL: /products?query1=value1&query2=value2
- Access: req.query
- Commom uses:
- Searching
- Filtering
- Sorting
- Pagination
- Route parameters
- Used to identify a specific resource
- URL: /products/10
- Access: req.params
- Declare: /products/:id (Hence, req.params.id = 10)
- PATCH vs PUT
- PATCH: Partial updates
- PUT: Complete replacement
- Reference image: https://javacodehouse.com/assets/img/thumb/PUT-vs-PATCH.svg
*/