Giter VIP home page Giter VIP logo

udomi_ljubimca-user-servis's Introduction

This is preview of user service

User.Service.1.mov
User.Service.2.mov
Below we can see high level logic of User Service api
Detailed api specification, especially information about json specification, should be found in swagger/openapi documentation of User Service api (which is built into app).

Animal association

/create_animal_association

  • This route should be only open to register service.

  • When user register, register service should send api request to user service.

  • Check if animal association already exist

  • keycloak_id is used to uniquely determine animal association.

  • Authorization is based on keycloak_id. In other words, if you know keycloak_id, you can perform any action.

  • Check length of fields. Keycloak_id can be of maximum of 100 numbers. Other fields have maximum of 50 characters.

  • Parameters:

    • keycloak_id
    • email
    • association_name
    • association_username

/read_animal_association

  • Check if animal association exist.

  • Returns relevant information.

  • Parameters:

    • keycloak_id

/update_animal_association

  • Check if animal association exist.

  • Check if city_id exist. As a city_id you can input only already predefined city ids.

  • Update relevant information.

  • Checks length of fields. About association has maximum of 500, keycloak_id 100, others maximum 50 characters.

  • Parameters:

    • keycloak_id
    • email
    • association_name
    • association_username
    • city_id
    • phone_number
    • about_association

/delete_animal_association

  • Check if animal association exist.

  • Set value of is_active field to be equal to 0.

  • Parameters:

    • keycloak_id

/all_animal_associations

  • There is no input parameters.

  • Calling this api route will return information about all registered animal associations.

  • No parameters.

Private Users

/create_private_user

  • This api route should be only open to register service.

  • When user registers, registration service should send api request with corresponding information to user service.

  • Checks if user already exist.

  • keycloak_id is used to uniquely determine personal users.

  • Authorization is based on keycloak_id. In other words, if you know keycloak_id, you can perform any action.

  • Checks length of fields. Keycloak_id has maximum of 100 characters, other fields max 50.

  • Parameters:

    • keycloak_id
    • name
    • surname
    • username
    • email

/read_private_user

  • Check if private user exist.

  • Return corresponding information.

  • Parameters:

    • keycloak_id

/update_private_user

  • Check if private user exist.

  • Checks if city_id exists in database. As city_id, you can input only already determined cities.

  • Update relevant information.

  • Check length of fields. Keycloak_id max 100, about me max 500, other fields max 50 characters.

  • Parameters:

    • keycloak_id
    • name
    • surname
    • username
    • email
    • city_id
    • about_me
    • date_of_bitth

Private Users Like

/like_animal

  • Check does user exist.

  • Check does animal exist.

  • Perform like.

  • Parameters:

    • animal_id
    • keycloak_id

/dislike_animal

  • Check does user exist.

  • Check does animal exist.

  • Check does specific user already liked specific animal.

  • Perform dislike operation.

  • Parameters:

    • animal_id
    • keycloak_id

/liked_animals_by_user

  • Check does user exist.

  • Returns all animals liked by specific user.

  • Parameters:

    • keycloak_id

To be done:

  • Image and PDF file CRUD operations.
  • API integration with animal service. Needed api route for checking if animal exists in database.
  • Creating dockerfile and docker-compose files.

udomi_ljubimca-user-servis's People

Contributors

milanzmitrovic 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.