saurabh-maurya0 / BackendCode_Project_VVnT

Welcome to the VVnT API documentation, showcasing the innovative backend code developed by Saurabh Maurya for VVnT Organization. Powered by SpringBoot, this code reflects precision and excellence, offering a seamless and robust experience. Dive into the realm of VVnT and witness Saurabh Maurya's vision, where every line of code signifies dedication

VVnT API Documentation

Welcome to the VVnT API documentation, showcasing the innovative backend code developed by Saurabh Maurya for VVnT Organization. Powered by SpringBoot, this code reflects precision and excellence, offering a seamless and robust experience. Dive into the realm of VVnT and witness Saurabh Maurya's vision, where every line of code signifies dedication, brilliance, and a commitment to unparalleled performance.

Contact Information

• Developer: Saurabh Maurya
• Website: VVnT
• Email: [e-mail]
• License: OPEN License

API Documentation External Docs

For additional information, please refer to our external documentation.

API Base URL

http://vvnt.up.railway.app - Generated server URL.

Table of Contents

1. UserController
   • Get Single User by UserId
   • Update User
   • Delete User
   • Get All Users
   • Create New User
   • Serve User Image
   • Upload User Image
   • Search Users
   • Get User by Email
   • Get Current User
2. AuthController
   • Login
   • Login with Google
   • ... (The rest of the AuthController operations follow a similar pattern)

---

UserController

Get Single User by UserId

• Endpoint: /users/{userId}
• Method: GET
• Parameters:
  • {userId}: User ID (String)
• Response:

  {
    // UserDto details
  }

Update User

• Endpoint: /users/{userId}
• Method: PUT
• Parameters:
  • {userId}: User ID (String)
• Request Body:

  {
    // UserDto details
  }

• Response:

  {
    // Updated UserDto details
  }

Delete User

• Endpoint: /users/{userId}
• Method: DELETE
• Parameters:
  • {userId}: User ID (String)
• Response:

  {
    "message": "User deleted successfully",
    "success": true,
    "status": "200 OK"
  }

Get All Users

• Endpoint: /users
• Method: GET
• Parameters:
  • pageNumber (Optional): Page number (Integer, default: 0)
  • pageSize (Optional): Page size (Integer, default: 10)
  • sortBy (Optional): Sort field (String, default: "name")
  • sortDir (Optional): Sort direction (String, default: "asc")
• Response:

  {
    // PageableResponseUserDto details
  }

Create New User

• Endpoint: /users
• Method: POST
• Request Body:

  {
    // UserDto details
  }

• Response:

  {
    // New UserDto details
  }

Serve User Image

• Endpoint: /users/image/{userId}
• Method: GET
• Parameters:
  • {userId}: User ID (String)
• Response:

  {
    // User image details
  }

Upload User Image

• Endpoint: /users/image/{userId}
• Method: POST
• Parameters:
  • {userId}: User ID (String)
• Request Body:

  {
    "userImage": "base64EncodedImage"
  }

• Response:

  {
    // ImageResponse details
  }

Search Users

• Endpoint: /users/search/{keywords}
• Method: GET
• Parameters:
  • {keywords}: Search keywords (String)
  • pageNumber (Optional): Page number (Integer, default: 0)
  • pageSize (Optional): Page size (Integer, default: 10)
  • sortBy (Optional): Sort field (String, default: "name")
  • sortDir (Optional): Sort direction (String, default: "asc")
• Response:

  {
    // PageableResponseUserDto details
  }

Get User by Email

• Endpoint: /users/email/{email}
• Method: GET
• Parameters:
  • {email}: User email (String)
• Response:

  {
    // UserDto details
  }

Get Current User

• Endpoint: /auth/current
• Method: GET
• Response:

  {
    // UserDto details
  }

---

AuthController

Login

• Endpoint: /auth/login
• Method: POST
• Request Body:

  {
    "email": "[e-mail]",
    "password": "password123"
  }

• Response:

  {
    "jwtToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "user": {
      // UserDto details
    }
  }

• Security: Bearer Token (JWT)

Login with Google

• Endpoint: /auth/google
• Method: POST
• Request Body:

  {
    // Google Sign-In response
  }

• Response:

  {
    "jwtToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "user": {
      // UserDto details
    }
  }

• Security: Bearer Token (JWT)

... (The rest of the AuthController operations follow a similar pattern)

---

This documentation provides a comprehensive guide to the VVnT API. Explore and integrate to experience the seamless blend of innovation and expertise.

This version includes the specified addition. Feel free to use and modify it as needed

.