Skip to content
This repository was archived by the owner on Oct 2, 2025. It is now read-only.

Commit 17f2903

Browse files
kkamarakkamara
committed
Add Postman API files to documentation
1 parent 8a53260 commit 17f2903

File tree

3 files changed

+243
-0
lines changed

3 files changed

+243
-0
lines changed

‎python-reactjs-boilerplate.postman_collection.json‎

Lines changed: 211 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,211 @@
1+
{
2+
"info": {
3+
"_postman_id": "2f358abd-5520-41ca-8515-f5cf4ab5936a",
4+
"name": "python-reactjs-boilerplate",
5+
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
6+
"_exporter_id": "17125932"
7+
},
8+
"item": [
9+
{
10+
"name": "auth",
11+
"item": [
12+
{
13+
"name": "Create User",
14+
"request": {
15+
"method": "POST",
16+
"header": [],
17+
"body": {
18+
"mode": "raw",
19+
"raw": "{\n \"username\": \"new_standard_user1\",\n \"email\": \"new_standard_user1@django-app.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"password\": \"passwordpassword\",\n \"re_password\": \"passwordpassword\"\n}",
20+
"options": {
21+
"raw": {
22+
"language": "json"
23+
}
24+
}
25+
},
26+
"url": {
27+
"raw": "{{host}}/api/v1/auth/users/",
28+
"host": [
29+
"{{host}}"
30+
],
31+
"path": [
32+
"api",
33+
"v1",
34+
"auth",
35+
"users",
36+
""
37+
]
38+
}
39+
},
40+
"response": []
41+
},
42+
{
43+
"name": "Email Confirmation",
44+
"request": {
45+
"method": "POST",
46+
"header": [],
47+
"body": {
48+
"mode": "raw",
49+
"raw": "{\n \"uid\": \"\",\n \"token\": \"\"\n}",
50+
"options": {
51+
"raw": {
52+
"language": "json"
53+
}
54+
}
55+
},
56+
"url": {
57+
"raw": "{{host}}/api/v1/auth/users/",
58+
"host": [
59+
"{{host}}"
60+
],
61+
"path": [
62+
"api",
63+
"v1",
64+
"auth",
65+
"users",
66+
""
67+
]
68+
}
69+
},
70+
"response": []
71+
},
72+
{
73+
"name": "Login User",
74+
"request": {
75+
"method": "POST",
76+
"header": [],
77+
"body": {
78+
"mode": "raw",
79+
"raw": "{\n \"email\": \"admin@django-app.com\",\n \"password\": \"secret\"\n}",
80+
"options": {
81+
"raw": {
82+
"language": "json"
83+
}
84+
}
85+
},
86+
"url": {
87+
"raw": "{{host}}/api/v1/auth/jwt/create/",
88+
"host": [
89+
"{{host}}"
90+
],
91+
"path": [
92+
"api",
93+
"v1",
94+
"auth",
95+
"jwt",
96+
"create",
97+
""
98+
]
99+
}
100+
},
101+
"response": []
102+
},
103+
{
104+
"name": "Password Reset",
105+
"request": {
106+
"method": "POST",
107+
"header": [],
108+
"body": {
109+
"mode": "raw",
110+
"raw": "{\n \"email\": \"new_standard_user1@django-app.com\"\n}",
111+
"options": {
112+
"raw": {
113+
"language": "json"
114+
}
115+
}
116+
},
117+
"url": {
118+
"raw": "{{host}}/api/v1/auth/users/reset_password/",
119+
"host": [
120+
"{{host}}"
121+
],
122+
"path": [
123+
"api",
124+
"v1",
125+
"auth",
126+
"users",
127+
"reset_password",
128+
""
129+
]
130+
}
131+
},
132+
"response": []
133+
},
134+
{
135+
"name": "Password Reset Confirmation",
136+
"request": {
137+
"method": "POST",
138+
"header": [],
139+
"body": {
140+
"mode": "raw",
141+
"raw": "{\n \"new_password\": \"passwordpassword1\",\n \"re_new_password\": \"passwordpassword1\",\n \"uid\": \"MjE\",\n \"token\": \"b2wp68-bc5619fa7acc6a6bdb315052dca5c2e6\"\n}",
142+
"options": {
143+
"raw": {
144+
"language": "json"
145+
}
146+
}
147+
},
148+
"url": {
149+
"raw": "{{host}}/api/v1/auth/users/reset_password_confirm/",
150+
"host": [
151+
"{{host}}"
152+
],
153+
"path": [
154+
"api",
155+
"v1",
156+
"auth",
157+
"users",
158+
"reset_password_confirm",
159+
""
160+
]
161+
}
162+
},
163+
"response": []
164+
},
165+
{
166+
"name": "Get User",
167+
"protocolProfileBehavior": {
168+
"disableBodyPruning": true
169+
},
170+
"request": {
171+
"auth": {
172+
"type": "bearer",
173+
"bearer": [
174+
{
175+
"key": "token",
176+
"value": "{{token}}",
177+
"type": "string"
178+
}
179+
]
180+
},
181+
"method": "GET",
182+
"header": [],
183+
"body": {
184+
"mode": "raw",
185+
"raw": "{\n \"email\": \"admin@django-app.com\",\n \"password\": \"secret\"\n}",
186+
"options": {
187+
"raw": {
188+
"language": "json"
189+
}
190+
}
191+
},
192+
"url": {
193+
"raw": "{{host}}/api/v1/auth/users/me",
194+
"host": [
195+
"{{host}}"
196+
],
197+
"path": [
198+
"api",
199+
"v1",
200+
"auth",
201+
"users",
202+
"me"
203+
]
204+
}
205+
},
206+
"response": []
207+
}
208+
]
209+
}
210+
]
211+
}

‎python-reactjs-boilerplate.postman_environment.json‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"id": "28043c48-1fa2-4299-9ce7-8e7ac3eb5e8a",
3+
"name": "python-reactjs-boilerplate",
4+
"values": [
5+
{
6+
"key": "host",
7+
"value": "http://localhost",
8+
"type": "default",
9+
"enabled": true
10+
},
11+
{
12+
"key": "token",
13+
"value": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjQ4NDIzOTY2LCJqdGkiOiI0YzRkYjFjMmM1MTQ0NTNlODA5MWI2YTA2MGI4ZjVhYSIsInVzZXJfaWQiOiIzM2Q2OTI1NC1kNTQwLTQ0M2ItYjM1My03NzNkOTI1ZGQ1ZmUifQ.hdX0zBkIiKv8HwULSPMma0ueAPeCQSlDOCbVoLgil38",
14+
"type": "default",
15+
"enabled": true
16+
}
17+
],
18+
"_postman_variable_scope": "environment",
19+
"_postman_exported_at": "2025-04-27T17:11:09.040Z",
20+
"_postman_exported_using": "Postman/11.42.4"
21+
}

‎readme.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
(2022) With docker support.
44

5+
* [Using Postman?](#postman)
6+
57
* [Installation](#installation)
68

79
* [Add testing seed data](#add-testing-seed-data)
@@ -26,6 +28,15 @@
2628

2729
* [License](#license)
2830

31+
<a name="postman"></a>
32+
## Using Postman?
33+
34+
[Get Postman HTTP client](https://www.postman.com/).
35+
36+
[Postman API Collection for Python ReactJS Boilerplate](https://github.com/kkamara/python-reactjs-boilerplate/blob/main/python-reactjs-boilerplate.postman_collection.json).
37+
38+
[Postman API Environment for Python ReactJS Boilerplate](https://github.com/kkamara/python-reactjs-boilerplate/blob/main/python-reactjs-boilerplate.postman_environment.json).
39+
2940
## Installation
3041

3142
```bash

0 commit comments

Comments
 (0)