// Template for Server Response
interface ApiResponse<T> {
success: boolean;
message: string;
data?: T;
error?: ApiError;
}
export interface ApiError {
code: string;
message: string;
details?: Record<string, unknown>;
}
Sample Successful Response
{
"success": true,
"message": "User registered successfully",
"data": {
"accessToken": 'eyJhbGci...',
"refreshToken": 'eyJhbGci...',
"user": {
"id": 'user_123',
"email": '[email protected]',
"username": 'dev_user',
"createdAt": '2023-08-20T12:34:56Z'
}
},
};
Sample Error Response
{
"success": false,
"message": "Validation failed",
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid input data",
"details": {
"email": "Invalid email format",
"password": "Must contain at least 8 characters"
}
}
}
Base URL
BASE URL Format = /api/ENTITY_NAME/ENDPOINT
/api/auth/login
/api/roadmap/roadmap_id
Services:
Authentication Service
Time Line Service
Segment Service
LLM Service