diff --git a/API/JWT/JWT Authentication.postman_collection.json b/API/JWT/JWT Authentication.postman_collection.json new file mode 100644 index 0000000..1751adc --- /dev/null +++ b/API/JWT/JWT Authentication.postman_collection.json @@ -0,0 +1,306 @@ +{ + "info": { + "_postman_id": "845fc421-f049-436a-a73c-c42496b5b105", + "name": "JWT Authentication", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "_exporter_id": "26260450" + }, + "item": [ + { + "name": "Register", + "request": { + "auth": { + "type": "noauth" + }, + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\":\"nima\",\n \"email\":\"nima_8a@yahoo.com\",\n \"password\":\"12345678\",\n \"password_confirmation\":\"12345678\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "http://127.0.0.1:8000/api/register", + "protocol": "http", + "host": [ + "127", + "0", + "0", + "1" + ], + "port": "8000", + "path": [ + "api", + "register" + ] + } + }, + "response": [] + }, + { + "name": "Login", + "request": { + "auth": { + "type": "noauth" + }, + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"email\":\"nima_8a@yahoo.com\",\n \"password\":\"12345678\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "http://127.0.0.1:8000/api/login", + "protocol": "http", + "host": [ + "127", + "0", + "0", + "1" + ], + "port": "8000", + "path": [ + "api", + "login" + ] + } + }, + "response": [] + }, + { + "name": "Logout", + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vMTI3LjAuMC4xOjgwMDAvYXBpL2xvZ2luIiwiaWF0IjoxNzQ1NDMwNjM3LCJleHAiOjE3NDU0MzQyMzcsIm5iZiI6MTc0NTQzMDYzNywianRpIjoieTZ4SzNpc2lpYm5Pc0hTeSIsInN1YiI6IjIiLCJwcnYiOiIyM2JkNWM4OTQ5ZjYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3In0.Vl0MDCZ3225YGLQYamlA6A1_iwMscz2Uj1vFMW2s6mU", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "http://127.0.0.1:8000/api/logout", + "protocol": "http", + "host": [ + "127", + "0", + "0", + "1" + ], + "port": "8000", + "path": [ + "api", + "logout" + ] + } + }, + "response": [] + }, + { + "name": "Delete Account", + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vMTI3LjAuMC4xOjgwMDAvYXBpL2xvZ2luIiwiaWF0IjoxNzQ1NDMwODY0LCJleHAiOjE3NDU0MzQ0NjQsIm5iZiI6MTc0NTQzMDg2NCwianRpIjoiOUNWWmxaNjhVV0Y1QXBLSiIsInN1YiI6IjIiLCJwcnYiOiIyM2JkNWM4OTQ5ZjYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3In0.Ao2vzDJnkfjXgpCSKuh1Fh63RvEEpLFAqjrXoJfg6jw", + "type": "string" + } + ] + }, + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "http://127.0.0.1:8000/api/deleteAcconut", + "protocol": "http", + "host": [ + "127", + "0", + "0", + "1" + ], + "port": "8000", + "path": [ + "api", + "deleteAcconut" + ] + } + }, + "response": [] + }, + { + "name": "Email Notification Send", + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vMTI3LjAuMC4xOjgwMDAvYXBpL2xvZ2luIiwiaWF0IjoxNzQ1NDMxMTAyLCJleHAiOjE3NDU0MzQ3MDIsIm5iZiI6MTc0NTQzMTEwMiwianRpIjoiQjZRbXRlRkRuVGZ1WVhZZiIsInN1YiI6IjEiLCJwcnYiOiIyM2JkNWM4OTQ5ZjYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3In0.ap0sM1lcDrQ2W2oTVCDQLQZK2aS94pKmj1K6p77RNA8", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "http://127.0.0.1:8000/api/email/verification-notification", + "protocol": "http", + "host": [ + "127", + "0", + "0", + "1" + ], + "port": "8000", + "path": [ + "api", + "email", + "verification-notification" + ] + } + }, + "response": [] + }, + { + "name": "Verify Email", + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vMTI3LjAuMC4xOjgwMDAvYXBpL2xvZ2luIiwiaWF0IjoxNzQ1NDMxMTAyLCJleHAiOjE3NDU0MzQ3MDIsIm5iZiI6MTc0NTQzMTEwMiwianRpIjoiQjZRbXRlRkRuVGZ1WVhZZiIsInN1YiI6IjEiLCJwcnYiOiIyM2JkNWM4OTQ5ZjYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3In0.ap0sM1lcDrQ2W2oTVCDQLQZK2aS94pKmj1K6p77RNA8", + "type": "string" + } + ] + }, + "method": "GET", + "header": [], + "url": { + "raw": "http://127.0.0.1:8000/api/email/verify/1/a410347aabe0039597cb405f771f043d411e4167?expires=1745434739&signature=6add506c4c1a09ac0fb7556d32f20cc84afeb2d523a6a77b400e0a4d0eff2920", + "protocol": "http", + "host": [ + "127", + "0", + "0", + "1" + ], + "port": "8000", + "path": [ + "api", + "email", + "verify", + "1", + "a410347aabe0039597cb405f771f043d411e4167" + ], + "query": [ + { + "key": "expires", + "value": "1745434739" + }, + { + "key": "signature", + "value": "6add506c4c1a09ac0fb7556d32f20cc84afeb2d523a6a77b400e0a4d0eff2920" + } + ] + } + }, + "response": [] + }, + { + "name": "Forgot Password", + "request": { + "auth": { + "type": "noauth" + }, + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"email\":\"nima.8ak@gmail.com\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "http://127.0.0.1:8000/api/forgot-password", + "protocol": "http", + "host": [ + "127", + "0", + "0", + "1" + ], + "port": "8000", + "path": [ + "api", + "forgot-password" + ] + } + }, + "response": [] + } + ] +} \ No newline at end of file diff --git a/API/JWT/app/Http/Controllers/API/Auth/DeleteAccountController.php b/API/JWT/app/Http/Controllers/API/Auth/DeleteAccountController.php index d0339ed..a9bfc26 100644 --- a/API/JWT/app/Http/Controllers/API/Auth/DeleteAccountController.php +++ b/API/JWT/app/Http/Controllers/API/Auth/DeleteAccountController.php @@ -9,6 +9,32 @@ use Illuminate\Support\Facades\Auth; class DeleteAccountController extends Controller { + /** + * @OA\Delete( + * path="/api/deleteAcconut", + * tags={"Authentication"}, + * summary="Delete user account", + * description="Deletes the currently authenticated user's account and invalidates the JWT token.", + * security={{"bearerAuth":{}}}, + * @OA\Response( + * response=200, + * description="Account deleted successfully", + * @OA\JsonContent( + * @OA\Property(property="status", type="integer", example=1), + * @OA\Property(property="message", type="string", example="Your account has been deleted successfully. We’re sorry to see you go.") + * ) + * ), + * @OA\Response( + * response=500, + * description="Account deletion failed", + * @OA\JsonContent( + * @OA\Property(property="status", type="integer", example=0), + * @OA\Property(property="error", type="string", example="We couldn’t delete your account at this moment. Please try again later."), + * @OA\Property(property="message", type="string", example="Exception message") + * ) + * ) + * ) + */ public function deleteAcconut() { try { diff --git a/API/JWT/app/Http/Controllers/API/Auth/LoginController.php b/API/JWT/app/Http/Controllers/API/Auth/LoginController.php index 494d06d..0b07730 100644 --- a/API/JWT/app/Http/Controllers/API/Auth/LoginController.php +++ b/API/JWT/app/Http/Controllers/API/Auth/LoginController.php @@ -10,6 +10,52 @@ use Tymon\JWTAuth\Facades\JWTAuth; class LoginController extends BaseController { + /** + * @OA\Post( + * path="/api/login", + * tags={"Authentication"}, + * summary="User login", + * description="Logs in a user and returns a JWT token if credentials are correct.", + * @OA\RequestBody( + * required=true, + * @OA\JsonContent( + * required={"email", "password"}, + * @OA\Property(property="email", type="string", format="email", example="nima.8ak@gmail.com"), + * @OA\Property(property="password", type="string", format="password", example="12345678") + * ) + * ), + * @OA\Response( + * response=200, + * description="Login successful", + * @OA\JsonContent( + * @OA\Property(property="status", type="integer", example=1), + * @OA\Property(property="message", type="string", example="Login successful. Welcome back!"), + * @OA\Property(property="data", type="object", + * @OA\Property(property="name", type="string", example="Nima Malakooti"), + * @OA\Property(property="email", type="string", example="nima.8ak@gmail.com"), + * @OA\Property(property="token", type="string", example="Bearer eyJ0eXAiOiJKV1QiLCJhbGci...") + * ) + * ) + * ), + * @OA\Response( + * response=401, + * description="Unauthorized access", + * @OA\JsonContent( + * @OA\Property(property="status", type="integer", example=0), + * @OA\Property(property="message", type="string", example="Unauthorized access. Please check your credentials and try again.") + * ) + * ), + * @OA\Response( + * response=500, + * description="Failed to login", + * @OA\JsonContent( + * @OA\Property(property="status", type="integer", example=0), + * @OA\Property(property="message", type="string", example="Failed to login user. Please try again later."), + * @OA\Property(property="error", type="string", example="Exception message here") + * ) + * ) + * ) + */ public function login(LoginRequest $request) { try { diff --git a/API/JWT/app/Http/Controllers/API/Auth/LogoutController.php b/API/JWT/app/Http/Controllers/API/Auth/LogoutController.php index 891645d..84a46fe 100644 --- a/API/JWT/app/Http/Controllers/API/Auth/LogoutController.php +++ b/API/JWT/app/Http/Controllers/API/Auth/LogoutController.php @@ -9,6 +9,32 @@ use Illuminate\Support\Facades\Auth; class LogoutController extends Controller { + /** + * @OA\Post( + * path="/api/logout", + * tags={"Authentication"}, + * summary="Logout user", + * description="Logs out the currently authenticated user by invalidating the JWT token.", + * security={{"bearerAuth":{}}}, + * @OA\Response( + * response=200, + * description="Logout successful", + * @OA\JsonContent( + * @OA\Property(property="status", type="integer", example=1), + * @OA\Property(property="message", type="string", example="You have been logged out successfully. Come back soon!") + * ) + * ), + * @OA\Response( + * response=500, + * description="Logout failed", + * @OA\JsonContent( + * @OA\Property(property="status", type="integer", example=0), + * @OA\Property(property="message", type="string", example="Oops! Something went wrong while logging out. Please try again later."), + * @OA\Property(property="error", type="string", example="Exception message") + * ) + * ) + * ) + */ public function logout() { try { diff --git a/API/JWT/app/Http/Controllers/API/Auth/Mail/SendMailNotificationController.php b/API/JWT/app/Http/Controllers/API/Auth/Mail/SendMailNotificationController.php index 7f9cc7f..8269483 100644 --- a/API/JWT/app/Http/Controllers/API/Auth/Mail/SendMailNotificationController.php +++ b/API/JWT/app/Http/Controllers/API/Auth/Mail/SendMailNotificationController.php @@ -7,6 +7,32 @@ use Illuminate\Http\Request; class SendMailNotificationController extends Controller { + /** + * @OA\Post( + * path="/api/email/verification-notification", + * tags={"Authentication"}, + * summary="Send verification email", + * description="Sends a verification email to the authenticated user.", + * security={{"bearerAuth":{}}}, + * @OA\Response( + * response=200, + * description="Verification email sent", + * @OA\JsonContent( + * @OA\Property(property="status", type="integer", example=1), + * @OA\Property(property="message", type="string", example="Please check your email for the verification link.") + * ) + * ), + * @OA\Response( + * response=500, + * description="Error while sending email", + * @OA\JsonContent( + * @OA\Property(property="status", type="integer", example=0), + * @OA\Property(property="error", type="string", example="We encountered an issue while sending the verification email. Please try again later."), + * @OA\Property(property="message", type="string", example="Exception message") + * ) + * ) + * ) + */ public function mailNotification(Request $request) { try { diff --git a/API/JWT/app/Http/Controllers/API/Auth/Mail/VerifyMailController.php b/API/JWT/app/Http/Controllers/API/Auth/Mail/VerifyMailController.php index d646134..eff33f5 100644 --- a/API/JWT/app/Http/Controllers/API/Auth/Mail/VerifyMailController.php +++ b/API/JWT/app/Http/Controllers/API/Auth/Mail/VerifyMailController.php @@ -8,6 +8,45 @@ use Illuminate\Http\Request; class VerifyMailController extends Controller { + /** + * @OA\Get( + * path="/api/email/verify/{id}/{hash}", + * tags={"Authentication"}, + * summary="Verify user email", + * description="Verifies the user's email using the verification link.", + * @OA\Parameter( + * name="id", + * in="path", + * required=true, + * description="User ID", + * @OA\Schema(type="integer", example=1) + * ), + * @OA\Parameter( + * name="hash", + * in="path", + * required=true, + * description="Email verification hash", + * @OA\Schema(type="string", example="9e4f889aabbc...") + * ), + * @OA\Response( + * response=200, + * description="Email verified successfully", + * @OA\JsonContent( + * @OA\Property(property="status", type="integer", example=1), + * @OA\Property(property="message", type="string", example="Your email has been successfully verified. Thank you!") + * ) + * ), + * @OA\Response( + * response=500, + * description="Verification failed", + * @OA\JsonContent( + * @OA\Property(property="status", type="integer", example=0), + * @OA\Property(property="error", type="string", example="Your verification link was found, but something went wrong during the confirmation process. Please try again or request a new verification email."), + * @OA\Property(property="message", type="string", example="Exception message") + * ) + * ) + * ) + */ public function verifyMail(EmailVerificationRequest $request) { try { diff --git a/API/JWT/app/Http/Controllers/API/Auth/Password/NotificationPasswordController.php b/API/JWT/app/Http/Controllers/API/Auth/Password/NotificationPasswordController.php index 3853fbb..46b3e3d 100644 --- a/API/JWT/app/Http/Controllers/API/Auth/Password/NotificationPasswordController.php +++ b/API/JWT/app/Http/Controllers/API/Auth/Password/NotificationPasswordController.php @@ -9,6 +9,38 @@ use App\Http\Requests\NotificationPasswordRequest; class NotificationPasswordController extends Controller { + /** + * @OA\Post( + * path="/api/forgot-password", + * tags={"Authentication"}, + * summary="Send password reset link", + * description="Sends a password reset link to the user's email address.", + * @OA\RequestBody( + * required=true, + * @OA\JsonContent( + * required={"email"}, + * @OA\Property(property="email", type="string", format="email", example="nima.8ak@gmail.com") + * ) + * ), + * @OA\Response( + * response=200, + * description="Password reset link sent or email not found", + * @OA\JsonContent( + * @OA\Property(property="status", type="integer", example=1), + * @OA\Property(property="message", type="string", example="We’ve emailed you the password reset link. Please check your inbox!") + * ) + * ), + * @OA\Response( + * response=500, + * description="Failed to send password reset email", + * @OA\JsonContent( + * @OA\Property(property="status", type="integer", example=0), + * @OA\Property(property="error", type="string", example="We couldn’t send the password reset email due to an error. Please try again later."), + * @OA\Property(property="message", type="string", example="Exception message") + * ) + * ) + * ) + */ public function passwordNotification(NotificationPasswordRequest $request) { try { diff --git a/API/JWT/app/Http/Controllers/API/Auth/Password/ResetPasswordController.php b/API/JWT/app/Http/Controllers/API/Auth/Password/ResetPasswordController.php index 21c9860..67cf005 100644 --- a/API/JWT/app/Http/Controllers/API/Auth/Password/ResetPasswordController.php +++ b/API/JWT/app/Http/Controllers/API/Auth/Password/ResetPasswordController.php @@ -13,6 +13,49 @@ use App\Http\Requests\ResetPasswordRequest; class ResetPasswordController extends Controller { + /** + * @OA\Post( + * path="/api/reset-password", + * tags={"Authentication"}, + * summary="Reset the user's password", + * description="Resets the password for the user using the provided token and new password.", + * @OA\RequestBody( + * required=true, + * @OA\JsonContent( + * required={"email", "password", "password_confirmation", "token"}, + * @OA\Property(property="email", type="string", format="email", example="nima.8ak@gmail.com"), + * @OA\Property(property="password", type="string", format="password", example="12345678"), + * @OA\Property(property="password_confirmation", type="string", format="password", example="12345678"), + * @OA\Property(property="token", type="string", example="valid-reset-token-here") + * ) + * ), + * @OA\Response( + * response=200, + * description="Password reset successfully", + * @OA\JsonContent( + * @OA\Property(property="status", type="integer", example=1), + * @OA\Property(property="message", type="string", example="Your password has been reset!") + * ) + * ), + * @OA\Response( + * response=400, + * description="Invalid token or mismatched password confirmation", + * @OA\JsonContent( + * @OA\Property(property="status", type="integer", example=0), + * @OA\Property(property="message", type="string", example="This password reset token is invalid.") + * ) + * ), + * @OA\Response( + * response=500, + * description="Internal server error", + * @OA\JsonContent( + * @OA\Property(property="status", type="integer", example=0), + * @OA\Property(property="error", type="string", example="We couldn’t process the request due to an error. Please try again later."), + * @OA\Property(property="message", type="string", example="Exception message") + * ) + * ) + * ) + */ public function resetPassword(ResetPasswordRequest $request) { try { diff --git a/API/JWT/app/Http/Controllers/API/Auth/RegisterController.php b/API/JWT/app/Http/Controllers/API/Auth/RegisterController.php index 706123a..47243cc 100644 --- a/API/JWT/app/Http/Controllers/API/Auth/RegisterController.php +++ b/API/JWT/app/Http/Controllers/API/Auth/RegisterController.php @@ -12,6 +12,47 @@ use App\Http\Controllers\API\Auth\BaseController; class RegisterController extends BaseController { + /** + * @OA\Post( + * path="/api/register", + * summary="Register a new user", + * description="Registers a user and returns a JWT token.", + * operationId="registerUser", + * tags={"Authentication"}, + * @OA\RequestBody( + * required=true, + * @OA\JsonContent( + * required={"name","email","password","password_confirmation"}, + * @OA\Property(property="name", type="string", example="Nima Malakooti"), + * @OA\Property(property="email", type="string", format="email", example="nima.8ak@gmail.com"), + * @OA\Property(property="password", type="string", format="password", example="12345678"), + * @OA\Property(property="password_confirmation", type="string", format="password", example="12345678"), + * ) + * ), + * @OA\Response( + * response=200, + * description="Successful registration", + * @OA\JsonContent( + * @OA\Property(property="status", type="integer", example=1), + * @OA\Property(property="message", type="string", example="User registered successfully."), + * @OA\Property(property="data", type="object", + * @OA\Property(property="name", type="string", example="Nima Malakooti"), + * @OA\Property(property="email", type="string", example="nima.8ak@gmail.com"), + * @OA\Property(property="token", type="string", example="Bearer eyJ0eXAiOiJKV1...") + * ) + * ) + * ), + * @OA\Response( + * response=500, + * description="Registration failed", + * @OA\JsonContent( + * @OA\Property(property="status", type="integer", example=0), + * @OA\Property(property="message", type="string", example="Failed to register user. Please try again later."), + * @OA\Property(property="error", type="string", example="Detailed error message") + * ) + * ) + * ) + */ public function register(RegisterRequest $request) { try { diff --git a/API/JWT/app/Http/Controllers/Controller.php b/API/JWT/app/Http/Controllers/Controller.php index 902f5f3..348d9f1 100644 --- a/API/JWT/app/Http/Controllers/Controller.php +++ b/API/JWT/app/Http/Controllers/Controller.php @@ -4,6 +4,11 @@ namespace App\Http\Controllers; use Tymon\JWTAuth\Facades\JWTAuth; -abstract class Controller { - -} + +/** + * @OA\Info( + * title="API Documentation", + * version="1.0.0" + * ) + */ +abstract class Controller {} diff --git a/API/JWT/composer.json b/API/JWT/composer.json index eb3721a..7cb7fe4 100644 --- a/API/JWT/composer.json +++ b/API/JWT/composer.json @@ -10,11 +10,13 @@ "license": "MIT", "require": { "php": "^8.2", + "darkaonline/l5-swagger": "^9.0", "laravel/framework": "^12.0", "laravel/sanctum": "^4.0", "laravel/tinker": "^2.10.1", "mailersend/laravel-driver": "^2.9", - "tymon/jwt-auth": "^2.2" + "tymon/jwt-auth": "^2.2", + "zircote/swagger-php": "^5.1" }, "require-dev": { "fakerphp/faker": "^1.23", diff --git a/API/JWT/composer.lock b/API/JWT/composer.lock index fb61fc9..f043c73 100644 --- a/API/JWT/composer.lock +++ b/API/JWT/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "46e6ca5d2fa1d64427ac16a117a3d06f", + "content-hash": "a988fd7da2b7e95aaa56b960a9030fa7", "packages": [ { "name": "beberlei/assert", @@ -268,6 +268,87 @@ ], "time": "2023-12-20T15:40:13+00:00" }, + { + "name": "darkaonline/l5-swagger", + "version": "9.0.1", + "source": { + "type": "git", + "url": "https://github.com/DarkaOnLine/L5-Swagger.git", + "reference": "2c26427f8c41db8e72232415e7287313e6b6a2e2" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/DarkaOnLine/L5-Swagger/zipball/2c26427f8c41db8e72232415e7287313e6b6a2e2", + "reference": "2c26427f8c41db8e72232415e7287313e6b6a2e2", + "shasum": "" + }, + "require": { + "doctrine/annotations": "^1.0 || ^2.0", + "ext-json": "*", + "laravel/framework": "^12.0 || ^11.0", + "php": "^8.2", + "swagger-api/swagger-ui": ">=5.18.3", + "symfony/yaml": "^5.0 || ^6.0 || ^7.0", + "zircote/swagger-php": "^5.0.0" + }, + "require-dev": { + "mockery/mockery": "1.*", + "orchestra/testbench": "^10.0 || ^9.0 || ^8.0 || 7.* || ^6.15 || 5.*", + "php-coveralls/php-coveralls": "^2.0", + "phpstan/phpstan": "^2.1", + "phpunit/phpunit": "^11.0" + }, + "type": "library", + "extra": { + "laravel": { + "aliases": { + "L5Swagger": "L5Swagger\\L5SwaggerFacade" + }, + "providers": [ + "L5Swagger\\L5SwaggerServiceProvider" + ] + } + }, + "autoload": { + "files": [ + "src/helpers.php" + ], + "psr-4": { + "L5Swagger\\": "src" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Darius Matulionis", + "email": "darius@matulionis.lt" + } + ], + "description": "OpenApi or Swagger integration to Laravel", + "keywords": [ + "api", + "documentation", + "laravel", + "openapi", + "specification", + "swagger", + "ui" + ], + "support": { + "issues": "https://github.com/DarkaOnLine/L5-Swagger/issues", + "source": "https://github.com/DarkaOnLine/L5-Swagger/tree/9.0.1" + }, + "funding": [ + { + "url": "https://github.com/DarkaOnLine", + "type": "github" + } + ], + "time": "2025-02-28T06:25:02+00:00" + }, { "name": "dflydev/dot-access-data", "version": "v3.0.3", @@ -343,6 +424,82 @@ }, "time": "2024-07-08T12:26:09+00:00" }, + { + "name": "doctrine/annotations", + "version": "2.0.2", + "source": { + "type": "git", + "url": "https://github.com/doctrine/annotations.git", + "reference": "901c2ee5d26eb64ff43c47976e114bf00843acf7" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/doctrine/annotations/zipball/901c2ee5d26eb64ff43c47976e114bf00843acf7", + "reference": "901c2ee5d26eb64ff43c47976e114bf00843acf7", + "shasum": "" + }, + "require": { + "doctrine/lexer": "^2 || ^3", + "ext-tokenizer": "*", + "php": "^7.2 || ^8.0", + "psr/cache": "^1 || ^2 || ^3" + }, + "require-dev": { + "doctrine/cache": "^2.0", + "doctrine/coding-standard": "^10", + "phpstan/phpstan": "^1.10.28", + "phpunit/phpunit": "^7.5 || ^8.5 || ^9.5", + "symfony/cache": "^5.4 || ^6.4 || ^7", + "vimeo/psalm": "^4.30 || ^5.14" + }, + "suggest": { + "php": "PHP 8.0 or higher comes with attributes, a native replacement for annotations" + }, + "type": "library", + "autoload": { + "psr-4": { + "Doctrine\\Common\\Annotations\\": "lib/Doctrine/Common/Annotations" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Guilherme Blanco", + "email": "guilhermeblanco@gmail.com" + }, + { + "name": "Roman Borschel", + "email": "roman@code-factory.org" + }, + { + "name": "Benjamin Eberlei", + "email": "kontakt@beberlei.de" + }, + { + "name": "Jonathan Wage", + "email": "jonwage@gmail.com" + }, + { + "name": "Johannes Schmitt", + "email": "schmittjoh@gmail.com" + } + ], + "description": "Docblock Annotations Parser", + "homepage": "https://www.doctrine-project.org/projects/annotations.html", + "keywords": [ + "annotations", + "docblock", + "parser" + ], + "support": { + "issues": "https://github.com/doctrine/annotations/issues", + "source": "https://github.com/doctrine/annotations/tree/2.0.2" + }, + "time": "2024-09-05T10:17:24+00:00" + }, { "name": "doctrine/inflector", "version": "2.0.10", @@ -3517,6 +3674,55 @@ ], "time": "2024-07-20T21:41:07+00:00" }, + { + "name": "psr/cache", + "version": "3.0.0", + "source": { + "type": "git", + "url": "https://github.com/php-fig/cache.git", + "reference": "aa5030cfa5405eccfdcb1083ce040c2cb8d253bf" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/php-fig/cache/zipball/aa5030cfa5405eccfdcb1083ce040c2cb8d253bf", + "reference": "aa5030cfa5405eccfdcb1083ce040c2cb8d253bf", + "shasum": "" + }, + "require": { + "php": ">=8.0.0" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.0.x-dev" + } + }, + "autoload": { + "psr-4": { + "Psr\\Cache\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "PHP-FIG", + "homepage": "https://www.php-fig.org/" + } + ], + "description": "Common interface for caching libraries", + "keywords": [ + "cache", + "psr", + "psr-6" + ], + "support": { + "source": "https://github.com/php-fig/cache/tree/3.0.0" + }, + "time": "2021-02-03T23:26:27+00:00" + }, { "name": "psr/clock", "version": "1.0.0", @@ -4220,6 +4426,67 @@ ], "time": "2024-04-27T21:32:50+00:00" }, + { + "name": "swagger-api/swagger-ui", + "version": "v5.21.0", + "source": { + "type": "git", + "url": "https://github.com/swagger-api/swagger-ui.git", + "reference": "fceaec605072fbc717a04895bd19814d9a1c8e6d" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/swagger-api/swagger-ui/zipball/fceaec605072fbc717a04895bd19814d9a1c8e6d", + "reference": "fceaec605072fbc717a04895bd19814d9a1c8e6d", + "shasum": "" + }, + "type": "library", + "notification-url": "https://packagist.org/downloads/", + "license": [ + "Apache-2.0" + ], + "authors": [ + { + "name": "Anna Bodnia", + "email": "anna.bodnia@gmail.com" + }, + { + "name": "Buu Nguyen", + "email": "buunguyen@gmail.com" + }, + { + "name": "Josh Ponelat", + "email": "jponelat@gmail.com" + }, + { + "name": "Kyle Shockey", + "email": "kyleshockey1@gmail.com" + }, + { + "name": "Robert Barnwell", + "email": "robert@robertismy.name" + }, + { + "name": "Sahar Jafari", + "email": "shr.jafari@gmail.com" + } + ], + "description": " Swagger UI is a collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.", + "homepage": "http://swagger.io", + "keywords": [ + "api", + "documentation", + "openapi", + "specification", + "swagger", + "ui" + ], + "support": { + "issues": "https://github.com/swagger-api/swagger-ui/issues", + "source": "https://github.com/swagger-api/swagger-ui/tree/v5.21.0" + }, + "time": "2025-04-13T19:37:38+00:00" + }, { "name": "symfony/clock", "version": "v7.2.0", @@ -6515,6 +6782,78 @@ ], "time": "2025-01-17T11:39:41+00:00" }, + { + "name": "symfony/yaml", + "version": "v7.2.5", + "source": { + "type": "git", + "url": "https://github.com/symfony/yaml.git", + "reference": "4c4b6f4cfcd7e52053f0c8bfad0f7f30fb924912" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/yaml/zipball/4c4b6f4cfcd7e52053f0c8bfad0f7f30fb924912", + "reference": "4c4b6f4cfcd7e52053f0c8bfad0f7f30fb924912", + "shasum": "" + }, + "require": { + "php": ">=8.2", + "symfony/deprecation-contracts": "^2.5|^3.0", + "symfony/polyfill-ctype": "^1.8" + }, + "conflict": { + "symfony/console": "<6.4" + }, + "require-dev": { + "symfony/console": "^6.4|^7.0" + }, + "bin": [ + "Resources/bin/yaml-lint" + ], + "type": "library", + "autoload": { + "psr-4": { + "Symfony\\Component\\Yaml\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Loads and dumps YAML files", + "homepage": "https://symfony.com", + "support": { + "source": "https://github.com/symfony/yaml/tree/v7.2.5" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2025-03-03T07:12:39+00:00" + }, { "name": "tijsverkoyen/css-to-inline-styles", "version": "v2.3.0", @@ -6869,6 +7208,92 @@ "source": "https://github.com/webmozarts/assert/tree/1.11.0" }, "time": "2022-06-03T18:03:27+00:00" + }, + { + "name": "zircote/swagger-php", + "version": "5.1.0", + "source": { + "type": "git", + "url": "https://github.com/zircote/swagger-php.git", + "reference": "a9b953c25f5bd11ea0542636936de04504496bd9" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/zircote/swagger-php/zipball/a9b953c25f5bd11ea0542636936de04504496bd9", + "reference": "a9b953c25f5bd11ea0542636936de04504496bd9", + "shasum": "" + }, + "require": { + "ext-json": "*", + "nikic/php-parser": "^4.19 || ^5.0", + "php": ">=7.4", + "psr/log": "^1.1 || ^2.0 || ^3.0", + "symfony/deprecation-contracts": "^2 || ^3", + "symfony/finder": "^5.0 || ^6.0 || ^7.0", + "symfony/yaml": "^5.0 || ^6.0 || ^7.0" + }, + "conflict": { + "symfony/process": ">=6, <6.4.14" + }, + "require-dev": { + "composer/package-versions-deprecated": "^1.11", + "doctrine/annotations": "^2.0", + "friendsofphp/php-cs-fixer": "^3.62.0", + "phpstan/phpstan": "^1.6 || ^2.0", + "phpunit/phpunit": "^9.0", + "rector/rector": "^1.0 || ^2.0", + "vimeo/psalm": "^4.30 || ^5.0" + }, + "suggest": { + "doctrine/annotations": "^2.0" + }, + "bin": [ + "bin/openapi" + ], + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "5.x-dev" + } + }, + "autoload": { + "psr-4": { + "OpenApi\\": "src" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "Apache-2.0" + ], + "authors": [ + { + "name": "Robert Allen", + "email": "zircote@gmail.com" + }, + { + "name": "Bob Fanger", + "email": "bfanger@gmail.com", + "homepage": "https://bfanger.nl" + }, + { + "name": "Martin Rademacher", + "email": "mano@radebatz.net", + "homepage": "https://radebatz.net" + } + ], + "description": "Generate interactive documentation for your RESTful API using PHP attributes (preferred) or PHPDoc annotations", + "homepage": "https://github.com/zircote/swagger-php", + "keywords": [ + "api", + "json", + "rest", + "service discovery" + ], + "support": { + "issues": "https://github.com/zircote/swagger-php/issues", + "source": "https://github.com/zircote/swagger-php/tree/5.1.0" + }, + "time": "2025-04-18T00:35:12+00:00" } ], "packages-dev": [ @@ -9908,78 +10333,6 @@ ], "time": "2024-10-20T05:08:20+00:00" }, - { - "name": "symfony/yaml", - "version": "v7.2.5", - "source": { - "type": "git", - "url": "https://github.com/symfony/yaml.git", - "reference": "4c4b6f4cfcd7e52053f0c8bfad0f7f30fb924912" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/symfony/yaml/zipball/4c4b6f4cfcd7e52053f0c8bfad0f7f30fb924912", - "reference": "4c4b6f4cfcd7e52053f0c8bfad0f7f30fb924912", - "shasum": "" - }, - "require": { - "php": ">=8.2", - "symfony/deprecation-contracts": "^2.5|^3.0", - "symfony/polyfill-ctype": "^1.8" - }, - "conflict": { - "symfony/console": "<6.4" - }, - "require-dev": { - "symfony/console": "^6.4|^7.0" - }, - "bin": [ - "Resources/bin/yaml-lint" - ], - "type": "library", - "autoload": { - "psr-4": { - "Symfony\\Component\\Yaml\\": "" - }, - "exclude-from-classmap": [ - "/Tests/" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Fabien Potencier", - "email": "fabien@symfony.com" - }, - { - "name": "Symfony Community", - "homepage": "https://symfony.com/contributors" - } - ], - "description": "Loads and dumps YAML files", - "homepage": "https://symfony.com", - "support": { - "source": "https://github.com/symfony/yaml/tree/v7.2.5" - }, - "funding": [ - { - "url": "https://symfony.com/sponsor", - "type": "custom" - }, - { - "url": "https://github.com/fabpot", - "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", - "type": "tidelift" - } - ], - "time": "2025-03-03T07:12:39+00:00" - }, { "name": "ta-tikoma/phpunit-architecture-test", "version": "0.8.4", diff --git a/API/JWT/config/l5-swagger.php b/API/JWT/config/l5-swagger.php new file mode 100644 index 0000000..a3ce546 --- /dev/null +++ b/API/JWT/config/l5-swagger.php @@ -0,0 +1,318 @@ + 'default', + 'documentations' => [ + 'default' => [ + 'api' => [ + 'title' => 'L5 Swagger UI', + ], + + 'routes' => [ + /* + * Route for accessing api documentation interface + */ + 'api' => 'api/documentation', + ], + 'paths' => [ + /* + * Edit to include full URL in ui for assets + */ + 'use_absolute_path' => env('L5_SWAGGER_USE_ABSOLUTE_PATH', true), + + /* + * Edit to set path where swagger ui assets should be stored + */ + 'swagger_ui_assets_path' => env('L5_SWAGGER_UI_ASSETS_PATH', 'vendor/swagger-api/swagger-ui/dist/'), + + /* + * File name of the generated json documentation file + */ + 'docs_json' => 'api-docs.json', + + /* + * File name of the generated YAML documentation file + */ + 'docs_yaml' => 'api-docs.yaml', + + /* + * Set this to `json` or `yaml` to determine which documentation file to use in UI + */ + 'format_to_use_for_docs' => env('L5_FORMAT_TO_USE_FOR_DOCS', 'json'), + + /* + * Absolute paths to directory containing the swagger annotations are stored. + */ + 'annotations' => [ + base_path('app'), + ], + ], + ], + ], + 'defaults' => [ + 'routes' => [ + /* + * Route for accessing parsed swagger annotations. + */ + 'docs' => 'docs', + + /* + * Route for Oauth2 authentication callback. + */ + 'oauth2_callback' => 'api/oauth2-callback', + + /* + * Middleware allows to prevent unexpected access to API documentation + */ + 'middleware' => [ + 'api' => [], + 'asset' => [], + 'docs' => [], + 'oauth2_callback' => [], + ], + + /* + * Route Group options + */ + 'group_options' => [], + ], + + 'paths' => [ + /* + * Absolute path to location where parsed annotations will be stored + */ + 'docs' => storage_path('api-docs'), + + /* + * Absolute path to directory where to export views + */ + 'views' => base_path('resources/views/vendor/l5-swagger'), + + /* + * Edit to set the api's base path + */ + 'base' => env('L5_SWAGGER_BASE_PATH', null), + + /* + * Absolute path to directories that should be excluded from scanning + * @deprecated Please use `scanOptions.exclude` + * `scanOptions.exclude` overwrites this + */ + 'excludes' => [], + ], + + 'scanOptions' => [ + /** + * Configuration for default processors. Allows to pass processors configuration to swagger-php. + * + * @link https://zircote.github.io/swagger-php/reference/processors.html + */ + 'default_processors_configuration' => [ + /** Example */ + /** + * 'operationId.hash' => true, + * 'pathFilter' => [ + * 'tags' => [ + * '/pets/', + * '/store/', + * ], + * ],. + */ + ], + + /** + * analyser: defaults to \OpenApi\StaticAnalyser . + * + * @see \OpenApi\scan + */ + 'analyser' => null, + + /** + * analysis: defaults to a new \OpenApi\Analysis . + * + * @see \OpenApi\scan + */ + 'analysis' => null, + + /** + * Custom query path processors classes. + * + * @link https://github.com/zircote/swagger-php/tree/master/Examples/processors/schema-query-parameter + * @see \OpenApi\scan + */ + 'processors' => [ + // new \App\SwaggerProcessors\SchemaQueryParameter(), + ], + + /** + * pattern: string $pattern File pattern(s) to scan (default: *.php) . + * + * @see \OpenApi\scan + */ + 'pattern' => null, + + /* + * Absolute path to directories that should be excluded from scanning + * @note This option overwrites `paths.excludes` + * @see \OpenApi\scan + */ + 'exclude' => [], + + /* + * Allows to generate specs either for OpenAPI 3.0.0 or OpenAPI 3.1.0. + * By default the spec will be in version 3.0.0 + */ + 'open_api_spec_version' => env('L5_SWAGGER_OPEN_API_SPEC_VERSION', \L5Swagger\Generator::OPEN_API_DEFAULT_SPEC_VERSION), + ], + + /* + * API security definitions. Will be generated into documentation file. + */ + 'securityDefinitions' => [ + 'securitySchemes' => [ + /* + * Examples of Security schemes + */ + /* + 'api_key_security_example' => [ // Unique name of security + 'type' => 'apiKey', // The type of the security scheme. Valid values are "basic", "apiKey" or "oauth2". + 'description' => 'A short description for security scheme', + 'name' => 'api_key', // The name of the header or query parameter to be used. + 'in' => 'header', // The location of the API key. Valid values are "query" or "header". + ], + 'oauth2_security_example' => [ // Unique name of security + 'type' => 'oauth2', // The type of the security scheme. Valid values are "basic", "apiKey" or "oauth2". + 'description' => 'A short description for oauth2 security scheme.', + 'flow' => 'implicit', // The flow used by the OAuth2 security scheme. Valid values are "implicit", "password", "application" or "accessCode". + 'authorizationUrl' => 'http://example.com/auth', // The authorization URL to be used for (implicit/accessCode) + //'tokenUrl' => 'http://example.com/auth' // The authorization URL to be used for (password/application/accessCode) + 'scopes' => [ + 'read:projects' => 'read your projects', + 'write:projects' => 'modify projects in your account', + ] + ], + */ + + /* Open API 3.0 support + 'passport' => [ // Unique name of security + 'type' => 'oauth2', // The type of the security scheme. Valid values are "basic", "apiKey" or "oauth2". + 'description' => 'Laravel passport oauth2 security.', + 'in' => 'header', + 'scheme' => 'https', + 'flows' => [ + "password" => [ + "authorizationUrl" => config('app.url') . '/oauth/authorize', + "tokenUrl" => config('app.url') . '/oauth/token', + "refreshUrl" => config('app.url') . '/token/refresh', + "scopes" => [] + ], + ], + ], + 'sanctum' => [ // Unique name of security + 'type' => 'apiKey', // Valid values are "basic", "apiKey" or "oauth2". + 'description' => 'Enter token in format (Bearer )', + 'name' => 'Authorization', // The name of the header or query parameter to be used. + 'in' => 'header', // The location of the API key. Valid values are "query" or "header". + ], + */ + ], + 'security' => [ + /* + * Examples of Securities + */ + [ + /* + 'oauth2_security_example' => [ + 'read', + 'write' + ], + + 'passport' => [] + */ + ], + ], + ], + + /* + * Set this to `true` in development mode so that docs would be regenerated on each request + * Set this to `false` to disable swagger generation on production + */ + 'generate_always' => env('L5_SWAGGER_GENERATE_ALWAYS', false), + + /* + * Set this to `true` to generate a copy of documentation in yaml format + */ + 'generate_yaml_copy' => env('L5_SWAGGER_GENERATE_YAML_COPY', false), + + /* + * Edit to trust the proxy's ip address - needed for AWS Load Balancer + * string[] + */ + 'proxy' => false, + + /* + * Configs plugin allows to fetch external configs instead of passing them to SwaggerUIBundle. + * See more at: https://github.com/swagger-api/swagger-ui#configs-plugin + */ + 'additional_config_url' => null, + + /* + * Apply a sort to the operation list of each API. It can be 'alpha' (sort by paths alphanumerically), + * 'method' (sort by HTTP method). + * Default is the order returned by the server unchanged. + */ + 'operations_sort' => env('L5_SWAGGER_OPERATIONS_SORT', null), + + /* + * Pass the validatorUrl parameter to SwaggerUi init on the JS side. + * A null value here disables validation. + */ + 'validator_url' => null, + + /* + * Swagger UI configuration parameters + */ + 'ui' => [ + 'display' => [ + 'dark_mode' => env('L5_SWAGGER_UI_DARK_MODE', false), + /* + * Controls the default expansion setting for the operations and tags. It can be : + * 'list' (expands only the tags), + * 'full' (expands the tags and operations), + * 'none' (expands nothing). + */ + 'doc_expansion' => env('L5_SWAGGER_UI_DOC_EXPANSION', 'none'), + + /** + * If set, enables filtering. The top bar will show an edit box that + * you can use to filter the tagged operations that are shown. Can be + * Boolean to enable or disable, or a string, in which case filtering + * will be enabled using that string as the filter expression. Filtering + * is case-sensitive matching the filter expression anywhere inside + * the tag. + */ + 'filter' => env('L5_SWAGGER_UI_FILTERS', true), // true | false + ], + + 'authorization' => [ + /* + * If set to true, it persists authorization data, and it would not be lost on browser close/refresh + */ + 'persist_authorization' => env('L5_SWAGGER_UI_PERSIST_AUTHORIZATION', false), + + 'oauth2' => [ + /* + * If set to true, adds PKCE to AuthorizationCodeGrant flow + */ + 'use_pkce_with_authorization_code_grant' => false, + ], + ], + ], + /* + * Constants which can be used in annotations + */ + 'constants' => [ + 'L5_SWAGGER_CONST_HOST' => env('L5_SWAGGER_CONST_HOST', 'http://my-default-host.com'), + ], + ], +]; diff --git a/API/JWT/resources/views/vendor/l5-swagger/.gitkeep b/API/JWT/resources/views/vendor/l5-swagger/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/API/JWT/resources/views/vendor/l5-swagger/index.blade.php b/API/JWT/resources/views/vendor/l5-swagger/index.blade.php new file mode 100644 index 0000000..4f57040 --- /dev/null +++ b/API/JWT/resources/views/vendor/l5-swagger/index.blade.php @@ -0,0 +1,174 @@ + + + + + {{ $documentationTitle }} + + + + + @if(config('l5-swagger.defaults.ui.display.dark_mode')) + + @endif + + + +
+ + + + + + diff --git a/API/JWT/routes/api.php b/API/JWT/routes/api.php index 34e52e6..57acdc1 100644 --- a/API/JWT/routes/api.php +++ b/API/JWT/routes/api.php @@ -20,7 +20,7 @@ Route::post('login', [LoginController::class, 'login'])->name('login'); Route::group(['middleware' => 'auth:api'], function () { Route::post('logout', [LogoutController::class, 'logout'])->name('logout'); - Route::post('deleteAcconut', [DeleteAccountController::class, 'deleteAcconut'])->name('delete.acconut'); + Route::delete('deleteAcconut', [DeleteAccountController::class, 'deleteAcconut'])->name('delete.acconut'); //email verification Route::post('/email/verification-notification', [SendMailNotificationController::class, 'mailNotification'])->name('mail.notification'); diff --git a/API/JWT/storage/api-docs/api-docs.json b/API/JWT/storage/api-docs/api-docs.json new file mode 100644 index 0000000..b5fa626 --- /dev/null +++ b/API/JWT/storage/api-docs/api-docs.json @@ -0,0 +1,694 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "API Documentation", + "version": "1.0.0" + }, + "paths": { + "/api/deleteAcconut": { + "delete": { + "tags": [ + "Authentication" + ], + "summary": "Delete user account", + "description": "Deletes the currently authenticated user's account and invalidates the JWT token.", + "operationId": "4cf0edfc2e1177da97815505b73e16e0", + "responses": { + "200": { + "description": "Account deleted successfully", + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "type": "integer", + "example": 1 + }, + "message": { + "type": "string", + "example": "Your account has been deleted successfully. We’re sorry to see you go." + } + }, + "type": "object" + } + } + } + }, + "500": { + "description": "Account deletion failed", + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "type": "integer", + "example": 0 + }, + "error": { + "type": "string", + "example": "We couldn’t delete your account at this moment. Please try again later." + }, + "message": { + "type": "string", + "example": "Exception message" + } + }, + "type": "object" + } + } + } + } + }, + "security": [ + { + "bearerAuth": [] + } + ] + } + }, + "/api/login": { + "post": { + "tags": [ + "Authentication" + ], + "summary": "User login", + "description": "Logs in a user and returns a JWT token if credentials are correct.", + "operationId": "e3ce052cc00fd9dd647e77abd7807e14", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "email", + "password" + ], + "properties": { + "email": { + "type": "string", + "format": "email", + "example": "nima.8ak@gmail.com" + }, + "password": { + "type": "string", + "format": "password", + "example": "12345678" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Login successful", + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "type": "integer", + "example": 1 + }, + "message": { + "type": "string", + "example": "Login successful. Welcome back!" + }, + "data": { + "properties": { + "name": { + "type": "string", + "example": "Nima Malakooti" + }, + "email": { + "type": "string", + "example": "nima.8ak@gmail.com" + }, + "token": { + "type": "string", + "example": "Bearer eyJ0eXAiOiJKV1QiLCJhbGci..." + } + }, + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "401": { + "description": "Unauthorized access", + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "type": "integer", + "example": 0 + }, + "message": { + "type": "string", + "example": "Unauthorized access. Please check your credentials and try again." + } + }, + "type": "object" + } + } + } + }, + "500": { + "description": "Failed to login", + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "type": "integer", + "example": 0 + }, + "message": { + "type": "string", + "example": "Failed to login user. Please try again later." + }, + "error": { + "type": "string", + "example": "Exception message here" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/api/logout": { + "post": { + "tags": [ + "Authentication" + ], + "summary": "Logout user", + "description": "Logs out the currently authenticated user by invalidating the JWT token.", + "operationId": "ad0ae046131d33ce33ee57a7f8a6a3f0", + "responses": { + "200": { + "description": "Logout successful", + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "type": "integer", + "example": 1 + }, + "message": { + "type": "string", + "example": "You have been logged out successfully. Come back soon!" + } + }, + "type": "object" + } + } + } + }, + "500": { + "description": "Logout failed", + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "type": "integer", + "example": 0 + }, + "message": { + "type": "string", + "example": "Oops! Something went wrong while logging out. Please try again later." + }, + "error": { + "type": "string", + "example": "Exception message" + } + }, + "type": "object" + } + } + } + } + }, + "security": [ + { + "bearerAuth": [] + } + ] + } + }, + "/api/email/verification-notification": { + "post": { + "tags": [ + "Authentication" + ], + "summary": "Send verification email", + "description": "Sends a verification email to the authenticated user.", + "operationId": "379b3fb09eb88cee77701aff98e2ee2b", + "responses": { + "200": { + "description": "Verification email sent", + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "type": "integer", + "example": 1 + }, + "message": { + "type": "string", + "example": "Please check your email for the verification link." + } + }, + "type": "object" + } + } + } + }, + "500": { + "description": "Error while sending email", + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "type": "integer", + "example": 0 + }, + "error": { + "type": "string", + "example": "We encountered an issue while sending the verification email. Please try again later." + }, + "message": { + "type": "string", + "example": "Exception message" + } + }, + "type": "object" + } + } + } + } + }, + "security": [ + { + "bearerAuth": [] + } + ] + } + }, + "/api/email/verify/{id}/{hash}": { + "get": { + "tags": [ + "Authentication" + ], + "summary": "Verify user email", + "description": "Verifies the user's email using the verification link.", + "operationId": "ddc92b84a9a7691538056ed633a285a6", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "User ID", + "required": true, + "schema": { + "type": "integer", + "example": 1 + } + }, + { + "name": "hash", + "in": "path", + "description": "Email verification hash", + "required": true, + "schema": { + "type": "string", + "example": "9e4f889aabbc..." + } + } + ], + "responses": { + "200": { + "description": "Email verified successfully", + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "type": "integer", + "example": 1 + }, + "message": { + "type": "string", + "example": "Your email has been successfully verified. Thank you!" + } + }, + "type": "object" + } + } + } + }, + "500": { + "description": "Verification failed", + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "type": "integer", + "example": 0 + }, + "error": { + "type": "string", + "example": "Your verification link was found, but something went wrong during the confirmation process. Please try again or request a new verification email." + }, + "message": { + "type": "string", + "example": "Exception message" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/api/forgot-password": { + "post": { + "tags": [ + "Authentication" + ], + "summary": "Send password reset link", + "description": "Sends a password reset link to the user's email address.", + "operationId": "ce31c7b7aa42b76f9e462c54075c43aa", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "email" + ], + "properties": { + "email": { + "type": "string", + "format": "email", + "example": "nima.8ak@gmail.com" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Password reset link sent or email not found", + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "type": "integer", + "example": 1 + }, + "message": { + "type": "string", + "example": "We’ve emailed you the password reset link. Please check your inbox!" + } + }, + "type": "object" + } + } + } + }, + "500": { + "description": "Failed to send password reset email", + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "type": "integer", + "example": 0 + }, + "error": { + "type": "string", + "example": "We couldn’t send the password reset email due to an error. Please try again later." + }, + "message": { + "type": "string", + "example": "Exception message" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/api/reset-password": { + "post": { + "tags": [ + "Authentication" + ], + "summary": "Reset the user's password", + "description": "Resets the password for the user using the provided token and new password.", + "operationId": "8e8229015b36555c6ad9564278a79929", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "email", + "password", + "password_confirmation", + "token" + ], + "properties": { + "email": { + "type": "string", + "format": "email", + "example": "nima.8ak@gmail.com" + }, + "password": { + "type": "string", + "format": "password", + "example": "12345678" + }, + "password_confirmation": { + "type": "string", + "format": "password", + "example": "12345678" + }, + "token": { + "type": "string", + "example": "valid-reset-token-here" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Password reset successfully", + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "type": "integer", + "example": 1 + }, + "message": { + "type": "string", + "example": "Your password has been reset!" + } + }, + "type": "object" + } + } + } + }, + "400": { + "description": "Invalid token or mismatched password confirmation", + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "type": "integer", + "example": 0 + }, + "message": { + "type": "string", + "example": "This password reset token is invalid." + } + }, + "type": "object" + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "type": "integer", + "example": 0 + }, + "error": { + "type": "string", + "example": "We couldn’t process the request due to an error. Please try again later." + }, + "message": { + "type": "string", + "example": "Exception message" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/api/register": { + "post": { + "tags": [ + "Authentication" + ], + "summary": "Register a new user", + "description": "Registers a user and returns a JWT token.", + "operationId": "registerUser", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "name", + "email", + "password", + "password_confirmation" + ], + "properties": { + "name": { + "type": "string", + "example": "Nima Malakooti" + }, + "email": { + "type": "string", + "format": "email", + "example": "nima.8ak@gmail.com" + }, + "password": { + "type": "string", + "format": "password", + "example": "12345678" + }, + "password_confirmation": { + "type": "string", + "format": "password", + "example": "12345678" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Successful registration", + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "type": "integer", + "example": 1 + }, + "message": { + "type": "string", + "example": "User registered successfully." + }, + "data": { + "properties": { + "name": { + "type": "string", + "example": "Nima Malakooti" + }, + "email": { + "type": "string", + "example": "nima.8ak@gmail.com" + }, + "token": { + "type": "string", + "example": "Bearer eyJ0eXAiOiJKV1..." + } + }, + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "500": { + "description": "Registration failed", + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "type": "integer", + "example": 0 + }, + "message": { + "type": "string", + "example": "Failed to register user. Please try again later." + }, + "error": { + "type": "string", + "example": "Detailed error message" + } + }, + "type": "object" + } + } + } + } + } + } + } + }, + "tags": [ + { + "name": "Authentication", + "description": "Authentication" + } + ] +} \ No newline at end of file