Skip to content

Commit 283eb4f

Browse files
tomanagletomanagle
committed
feat: postman collection
1 parent f644f22 commit 283eb4f

2 files changed

Lines changed: 304 additions & 4 deletions

File tree

‎README.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Build a REST API with Node.js, Mongoose & TypeScript
22

3+
Note: This repository includes the [postman collection for the finished API](./REST API Tutorial.postman_collection.json)
4+
35
## Who is this tutorial for?
46
* Junior to mid-level developers
57
* Anyone interested in building REST APIs with TypeScript
@@ -21,15 +23,12 @@
2123
* Node.js
2224
* MongoDB with Mongoose
2325
* TypeScript
24-
* Express & express middleware
26+
* Express.js & Express.js middleware
2527

2628
## Video structure
2729
1. What are we going to build
2830
2. Bootstrap application
2931
4. Build out registration
3032
5. Build out post CRUD operations
3133

32-
33-
34-
3534
![](./diagram.png)

‎REST API Tutorial.postman_collection.json‎

Lines changed: 301 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,301 @@
1+
{
2+
"info": {
3+
"_postman_id": "1d9409e8-9fea-4b58-af6a-7392bb4ead5b",
4+
"name": "REST API Tutorial",
5+
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
6+
},
7+
"item": [
8+
{
9+
"name": "Get Sessions",
10+
"request": {
11+
"method": "GET",
12+
"header": [
13+
{
14+
"key": "x-refresh",
15+
"value": "{{refreshToken}}",
16+
"type": "text"
17+
}
18+
],
19+
"url": {
20+
"raw": "http://localhost:1337/api/sessions",
21+
"protocol": "http",
22+
"host": [
23+
"localhost"
24+
],
25+
"port": "1337",
26+
"path": [
27+
"api",
28+
"sessions"
29+
]
30+
}
31+
},
32+
"response": []
33+
},
34+
{
35+
"name": "Update Post",
36+
"request": {
37+
"method": "PUT",
38+
"header": [
39+
{
40+
"key": "x-refresh",
41+
"value": "{{refreshToken}}",
42+
"type": "text"
43+
}
44+
],
45+
"body": {
46+
"mode": "raw",
47+
"raw": "{\n \"title\": \"A post title\",\n \"body\": \"Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text\"\n}",
48+
"options": {
49+
"raw": {
50+
"language": "json"
51+
}
52+
}
53+
},
54+
"url": {
55+
"raw": "http://localhost:1337/api/posts/{{postId}}",
56+
"protocol": "http",
57+
"host": [
58+
"localhost"
59+
],
60+
"port": "1337",
61+
"path": [
62+
"api",
63+
"posts",
64+
"{{postId}}"
65+
]
66+
}
67+
},
68+
"response": []
69+
},
70+
{
71+
"name": "Delete Post",
72+
"request": {
73+
"method": "DELETE",
74+
"header": [
75+
{
76+
"key": "x-refresh",
77+
"value": "{{refreshToken}}",
78+
"type": "text"
79+
}
80+
],
81+
"body": {
82+
"mode": "raw",
83+
"raw": "{\n \"title\": \"A post title\",\n \"body\": \"Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text\"\n}",
84+
"options": {
85+
"raw": {
86+
"language": "json"
87+
}
88+
}
89+
},
90+
"url": {
91+
"raw": "http://localhost:1337/api/posts/{{postId}}",
92+
"protocol": "http",
93+
"host": [
94+
"localhost"
95+
],
96+
"port": "1337",
97+
"path": [
98+
"api",
99+
"posts",
100+
"{{postId}}"
101+
]
102+
}
103+
},
104+
"response": []
105+
},
106+
{
107+
"name": "Create Post",
108+
"request": {
109+
"method": "POST",
110+
"header": [
111+
{
112+
"key": "x-refresh",
113+
"value": "{{refreshToken}}",
114+
"type": "text"
115+
}
116+
],
117+
"body": {
118+
"mode": "raw",
119+
"raw": "{\n \"title\": \"A post title\",\n \"body\": \"Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text\"\n}",
120+
"options": {
121+
"raw": {
122+
"language": "json"
123+
}
124+
}
125+
},
126+
"url": {
127+
"raw": "http://localhost:1337/api/posts",
128+
"protocol": "http",
129+
"host": [
130+
"localhost"
131+
],
132+
"port": "1337",
133+
"path": [
134+
"api",
135+
"posts"
136+
]
137+
}
138+
},
139+
"response": []
140+
},
141+
{
142+
"name": "Delete Session",
143+
"request": {
144+
"method": "DELETE",
145+
"header": [
146+
{
147+
"key": "x-refresh",
148+
"value": "{{refreshToken}}",
149+
"type": "text"
150+
}
151+
],
152+
"url": {
153+
"raw": "http://localhost:1337/api/sessions",
154+
"protocol": "http",
155+
"host": [
156+
"localhost"
157+
],
158+
"port": "1337",
159+
"path": [
160+
"api",
161+
"sessions"
162+
]
163+
}
164+
},
165+
"response": []
166+
},
167+
{
168+
"name": "Create Session",
169+
"request": {
170+
"method": "POST",
171+
"header": [],
172+
"body": {
173+
"mode": "raw",
174+
"raw": "{\n \"email\": \"{{email}}\",\n \"password\": \"{{password}}\"\n}",
175+
"options": {
176+
"raw": {
177+
"language": "json"
178+
}
179+
}
180+
},
181+
"url": {
182+
"raw": "http://localhost:1337/api/sessions",
183+
"protocol": "http",
184+
"host": [
185+
"localhost"
186+
],
187+
"port": "1337",
188+
"path": [
189+
"api",
190+
"sessions"
191+
]
192+
}
193+
},
194+
"response": []
195+
},
196+
{
197+
"name": "Create User",
198+
"request": {
199+
"method": "POST",
200+
"header": [],
201+
"body": {
202+
"mode": "raw",
203+
"raw": "{\n \"email\": \"{{email}}\",\n \"password\": \"{{password}}\",\n \"passwordConfirmation\": \"{{password}}\",\n \"name\": \"{{name}}\"\n}",
204+
"options": {
205+
"raw": {
206+
"language": "json"
207+
}
208+
}
209+
},
210+
"url": {
211+
"raw": "http://localhost:1337/api/users",
212+
"protocol": "http",
213+
"host": [
214+
"localhost"
215+
],
216+
"port": "1337",
217+
"path": [
218+
"api",
219+
"users"
220+
]
221+
}
222+
},
223+
"response": []
224+
},
225+
{
226+
"name": "Get Post",
227+
"protocolProfileBehavior": {
228+
"disableBodyPruning": true
229+
},
230+
"request": {
231+
"method": "GET",
232+
"header": [
233+
{
234+
"key": "x-refresh",
235+
"value": "{{refreshToken}}",
236+
"type": "text"
237+
}
238+
],
239+
"body": {
240+
"mode": "raw",
241+
"raw": "{\n \"title\": \"A post title\",\n \"body\": \"Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text Some HTML text\"\n}",
242+
"options": {
243+
"raw": {
244+
"language": "json"
245+
}
246+
}
247+
},
248+
"url": {
249+
"raw": "http://localhost:1337/api/posts/{{postId}}",
250+
"protocol": "http",
251+
"host": [
252+
"localhost"
253+
],
254+
"port": "1337",
255+
"path": [
256+
"api",
257+
"posts",
258+
"{{postId}}"
259+
]
260+
}
261+
},
262+
"response": []
263+
}
264+
],
265+
"auth": {
266+
"type": "bearer",
267+
"bearer": [
268+
{
269+
"key": "token",
270+
"value": "{{accessToken}}",
271+
"type": "string"
272+
}
273+
]
274+
},
275+
"event": [
276+
{
277+
"listen": "prerequest",
278+
"script": {
279+
"type": "text/javascript",
280+
"exec": [
281+
""
282+
]
283+
}
284+
},
285+
{
286+
"listen": "test",
287+
"script": {
288+
"type": "text/javascript",
289+
"exec": [
290+
""
291+
]
292+
}
293+
}
294+
],
295+
"variable": [
296+
{
297+
"key": "email",
298+
"value": "email"
299+
}
300+
]
301+
}

0 commit comments

Comments
 (0)