https://github.com/faysal-backend-developer/microservice
https://github.com/faysal-backend-developer/microservice
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/faysal-backend-developer/microservice
- Owner: faysal-backend-developer
- Created: 2025-07-01T20:03:23.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-03T12:46:24.000Z (about 1 year ago)
- Last Synced: 2025-07-03T13:46:19.283Z (about 1 year ago)
- Language: TypeScript
- Size: 67.4 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📡 API Documentation
This document outlines the available API endpoints for the **[E-Commerce]** service.
## 📁 Base URL : http://localhost:8080/api/v1
---
## 🔐 Authentication
All endpoints (unless marked as `Public`) require authentication using **Bearer Token** in the `Authorization` header:
---
## 🗂️ Endpoints Overview
| Method | Endpoint | Description | Auth Required |
| ------ | ----------------------- | ----------------------- | ------------- |
| GET | /user/ | Get all users | ✅ |
| POST | /user/signup | Create new user account | ❌ |
| POST | /user/login | User login | ❌ |
| POST | /user/verified | User login | ❌ |
| POST | /user/verifying_account | User login | ❌ |
| POST | /user/login | User login | ❌ |
| GET | /product/ | Get all products | |
| POST | /product/ | Create a new product | ✅ (Admin) |
| PUT | /product/:id | Update a product | ✅ (Admin) |
| DELETE | /products/:id | Delete a product | ✅ (Admin) |
---
## 🧑💻 API Endpoints Details
### 🔐 Auth Endpoints
#### `POST /auth/signup`
Register a new user.
- **Body Parameters:**
```json
{
"name": "John Doe",
"email": "john@example.com",
"password": "yourpassword"
}
```
Endpoints
Auth :
## url :http://localhost:8080/api/v1/user/signul
method: **post**
simpleData:
```
{
"name": "exampleName",
"email": "exampleEmail",
"password": "123456" (min 6 digit)
}
```
# Auth :
## Signup
## url : http://localhost:8080/user/signup
**Method: post**
Simple Data :
```
{
"name": "exampleName",
"email": "exampleEmail",
"password": "123456" (min 6 digit)
}
```
Response :
```
{
"success": true,
"message": "User SignUp Successfully",
"data": {
"email": "faysalhasan12@gmail.com",
"name": "Faysal",
"role": "USER",
"status": "PENDING",
"verified": false,
"id": "3ef9c10f-6cf5-46f0-ba7b-81044d622407"
},
"meta": null
}
```
---
## Account Verifying
## url : http://localhost:8080/user/verifying_account
**Method : Post**
Simple Data:
```
Body:
{
"code": "123456" (Check Mail and Get Code)
}
Headers: email : example@gmail.com
```
Response:
```
{
"success": true,
"message": "Account Verify Successful",
"data": {
"message": "Account Verified Successful"
},
"meta": null
}
```