rust-web-backend

web backend written in Rust language, for learning purposes

tech stack:

• PostgreSQL for database (https://hub.docker.com/_/postgres)
• Actix-web for routing (https://github.com/actix/actix-web)
• sqlx for sql object mapper (https://github.com/launchbadge/sqlx)
• jsonwebtoken for user authentication
• bcrypt for password hash

prerequsites:

• Install docker on your machine
• Install PostgreSQL using docker-compose:

docker-compose up -d

to run in development mode:

• modify ENV files, .env is needed for sqlx. Specify the DATABASE_URL according to your PostgreSQL
• create migrate database using pg admin
• execute:

cargo run -- -e dev

preparing for deployment:

to avoid sqlx compile time check, follow this steps:

• clone https://github.com/launchbadge/sqlx
• execute:

cargo install --path ./sqlx-cli
#after install, move to this project folder
cargo sqlx prepare
#sqlx-data.json will be generated, you can change the `DATABASE_URL` to real address of the database when deployed

to deploy:

• modify ENV files, DATABASE_URL on .env must be deleted
• execute:

docker build -t rust-app -f .Dockerfile .
docker-compose up -d

pre-built API:

• check email exist (customer)

curl --location --request POST 'localhost:8080/global/user/signup/check/email' \
--header 'x-api-key: your_api_key' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "[email protected]"
}'

• sign up (customer)

curl --location --request POST 'localhost:8080/global/user/signup' \
--header 'x-api-key: your_api_key' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "[email protected]" ,
    "password":"AlphaNum3ricW!thSpecialChar" ,
    "phone_number": "+628123456789" ,
    "name": "valid name"
}'

• user login (superadmin,admin,customer)

curl --location --request POST 'localhost:8080/global/user/login/web' \
--header 'x-api-key: your_api_key' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email":"[email protected]",
    "password":"AlphaNum3ricW!thSpecialChar"
}'

• get all user (superadmin,admin)

curl --location --request GET 'localhost:8080/admin/user/all' \
--header 'x-api-key: your_api_key' \
--header 'Cookie: Authorization=jwt token acquired after login'

• create new user (superadmin)

curl --location --request POST 'localhost:8080/superadmin/user/create' \
--header 'x-api-key: your_api_key' \
--header 'Content-Type: application/json' \
--header 'Cookie: Authorization=jwt token acquired after login' \
--data-raw '{
    "user_role": "customer" ,
    "email": "[email protected]" ,
    "password":"AlphaNum3ricW!thSpecialChar" ,
    "phone_number": "+628123456789" ,
    "name": "valid name"
    "date_of_birth": "1970-01-01"
}'

• verify user email (system)

curl --location --request GET 'localhost:8080/system/user/verify/email?token=jwt token sent to user email, front end need to pass the token to back end' \
--header 'x-api-key: your_api_key' \

• get user self profile (superadmin,admin,customer)

curl --location --request GET 'localhost:8080/global/user/protected/profile' \
--header 'x-api-key: your_api_key' \
--header 'Cookie:  Authorization=jwt token acquired after login'

• update user self profile (superadmin,admin,customer)

curl --location --request POST 'localhost:8080/global/user/protected/profile/update' \
--header 'x-api-key: your_api_key' \
--header 'Content-Type: application/json' \
--header 'Cookie: Authorization=jwt token acquired after login' \
--data-raw '{
    "phone_number":"+628123456789",
    "date_of_birth":"2005-10-10,
    "name":"valid name"
}'

• change password (superadmin,admin,customer)

curl --location --request POST 'localhost:8080/global/user/protected/password/change' \
--header 'x-api-key: your_api_key' \
--header 'Content-Type: application/json' \
--header 'Cookie: Authorization=jwt token acquired after login' \
--data-raw '{
    "previous_password":"OldPa55word-",
    "new_password":"N3wPassWord-"
}'