Giter VIP home page Giter VIP logo

saurabh-maurya1 / backendcode_project_vvnt Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 11.47 MB

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

Home Page: https://vvnt.up.railway.app/swagger-ui/index.html

License: MIT License

Java 100.00%
authentication authorization backend-devlopment backend-server code-documentation database-management google-sign-in image-display image-upload java jpa organization restful-api search security-management spring-boot swagger-api swagger-ui

backendcode_project_vvnt's Introduction

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

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
  2. AuthController

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": "[email protected]",
      "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

.

backendcode_project_vvnt's People

Contributors

saurabh-maurya1 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.