Spaces:
Sleeping
Sleeping
Add doc for login and signup
Browse files
backend/src/modules/authentication/README.md
ADDED
@@ -0,0 +1,33 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# Set up
|
2 |
+
Hiện tại cái **JWT_KEY** trong file **.env** vì lý do gì đó mà lúc đọc vào thì có lúc undefine, lúc ok nên t để cái JWT_KEY trong file constants.ts (ni t ignore cái file nớ rou)
|
3 |
+
* Vào src/modules/authentication tạo file **constants.ts** với nội dung sau:
|
4 |
+
```javascript
|
5 |
+
export const jwtConstants = {
|
6 |
+
secret: '',
|
7 |
+
};
|
8 |
+
```
|
9 |
+
Trong đó **secret** là một cái JWT key t sẽ cung cấp sau.
|
10 |
+
|
11 |
+
## Signup
|
12 |
+
**Url:** *http://localhost:3000/authentication/signup* <br>
|
13 |
+
**Method:** POST <br>
|
14 |
+
**Input:**
|
15 |
+
* full_name: Tên của người dùng
|
16 |
+
* Email: Tài khoản email, hiện đang để optional do chưa xử lý cái unique
|
17 |
+
* Số điện thoại: Số điện thoại đang để check mã vùng ở Việt Nam
|
18 |
+
* password: Độ dài ít nhất 8 ký tự <br>
|
19 |
+
**Output:**
|
20 |
+
* access_token
|
21 |
+
|
22 |
+
## Login
|
23 |
+
**Url:** *http://localhost:3000/authentication/login* <br>
|
24 |
+
**Method:** POST <br>
|
25 |
+
**Input:**
|
26 |
+
* username: hiện đang để là full_name, sau ni sẽ sửa lại database với code để email và số điện thoại là unique
|
27 |
+
* password: Độ dài ít nhất 8 ký tự
|
28 |
+
**Output:** <br>
|
29 |
+
* access_token
|
30 |
+
|
31 |
+
|
32 |
+
|
33 |
+
|