https://github.com/lnderjeet29/managewise

A backend service for managing business data efficiently and securely.
https://github.com/lnderjeet29/managewise

authentication-backend aws docker kotlin management management-system role-based-access-control rolebasedauthrorization spring-boot

Last synced: 25 days ago
JSON representation

A backend service for managing business data efficiently and securely.

• Host: GitHub
• URL: https://github.com/lnderjeet29/managewise
• Owner: lnderjeet29
• Created: 2024-08-23T19:04:04.000Z (5 months ago)
• Default Branch: master
• Last Pushed: 2024-11-27T07:21:46.000Z (about 2 months ago)
• Last Synced: 2024-11-27T08:26:28.507Z (about 2 months ago)
• Topics: authentication-backend, aws, docker, kotlin, management, management-system, role-based-access-control, rolebasedauthrorization, spring-boot
• Language: Kotlin
• Homepage:
• Size: 26.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


ManageWise - REST API Controllers

  


    Welcome to ManageWise, a backend service built using Spring Boot with Kotlin,

    designed to efficiently manage business, client, and user data. This repository contains the REST controllers

    for managing core application features.

  


  


  
🚀 Features

  


    
Business management with secure user authentication.

    
Client creation with structured input validation.

    
Health check endpoint for service monitoring.

    
User management including creation, retrieval, and updates.

    
Standardized error handling with meaningful response messages.

    
OpenAPI/Swagger integration for API documentation.

  


  


  
📂 Controller Overview


  
1. BusinessController



  
Manages business-related operations.

  
Endpoints:

  


    


      POST /v1/business


      Creates a new business.

      


        
Requires userHash in the request attributes for authentication.

        
Request Body: CreateBusinessDTO



        
Responses:

          


            


200 OK: Business Created Successfully.

            


401 Unauthorized: Invalid User.

          

        

      

    

  


  
2. ClientController



  
Handles client creation and management.

  
Endpoints:

  


    


      POST /v1/client


      Creates a new client.

      


        
Request Body: CreateClientRequestDto



        
Responses:

          


            


200 OK: Client created successfully.

            


500 Internal Server Error: An error occurred while creating the client.

          

        

      

    

  


  
3. HealthStatusController



  
Provides service health status.

  
Endpoints:

  


    


      GET /


      Returns service status.

      


        
Response Body: {"status": "up"}



      

    

  


  
4. UserController



  
Manages user-related operations including creation, retrieval, and updates.

  
Endpoints:

  


    


      POST /v1/user


      Creates a new user.

      


        
Requires userHash in the request attributes for authentication.

        
Request Body: CreateUserDto



        
Responses:

          


            


200 OK: User successfully created.

            


401 Unauthorized: Invalid User.

          

        

      

    

    


      GET /v1/user/{userHash}


      Retrieves user details by their unique hash.

    

    


      PATCH /v1/user/{userHash}


      Updates user details by their unique hash.

    

  


  


  
💬 Contact

  
Feel free to reach out for any questions or contributions:

  


    
Email: [email protected]



    
GitHub: https://github.com/inderjeet29