Rocket REST API with JWT

A Rusty Rocket 🚀 fuelled with Diesel 🛢 and secured by JWT 🔐

Require

You can build and run app from source:

• Rust
• Postgres

How to run

Manual

• Install Rust nightly (Thanks for Rustup 1.20!): rustup install nightly
• Set Rust Nightly to project: Go to the root of the project, open cmd/terminal and run rustup override set nightly
• Rename secret.key.sample to secret.key or create your own key by running head -c16 /dev/urandom > secret.key in command line (Linux/UNIX only) and copy to /src folder
• Create a database in postgres cli or pgAdmin tool
• Rename Rocket.toml.sample to Rocket.toml and update the database connection string in url key.
• Build with release profile: cargo build --release
• Run release binary in command line/terminal. On Windows: target/release/addressbookrestapi.exe, on *UNIX: target/release/addressbookrestapi
• Enjoy! 😄

Docker

• Enter into project directory and run docker-compose up
• Enjoy! 😄

APIs

Address: localhost:8000

POST /api/auth/signup: Signup

{
     "username": string,
     "email": string,
     "password": string       // a raw password
  }

{
       "message": "signup successfully",
       "data": ""
    }

{
       "message": "error when signing up, please try again",
       "data": ""
    }

POST /api/auth/login: Login

{
     "usernameoremail": string,
     "password": string       // a raw password
  }

{
       "message": "login successfully",
       "data": {
         "token": string      // bearer token
       }
    }

{
       "message": "wrong username or password, please try again",
       "data": ""
    }

GET /api/address-book: Get all people information

{
       "message": "ok",
       "data": [
          {
            "id": int32,
            "name": string,
            "gender": boolean,      // true for male, false for female
            "age": int32,
            "address": string,
            "phone": string,
            "email": string
          }
       ]
    }

{
       "message": "ok",
       "data": {
         "id": int32,
         "name": string,
         "gender": boolean,      // true for male, false for female
         "age": int32,
         "address": string,
         "phone": string,
         "email": string
       }
    }

{
       "message": "person with id {id} not found",
       "data": ""
    }

{
       "message": "ok",
       "data": [
         {
           "id": int32,
           "name": string,
           "gender": boolean,      // true for male, false for female
           "age": int32,
           "address": string,
           "phone": string,
           "email": string
         }
       ]
    }

{
      "name": string,
      "gender": boolean,      // true for male, false for female
      "age": int32,
      "address": string,
      "phone": string,
      "email": string
    }

{
      "message": "ok",
      "data": ""
    }

{
      "message": "can not insert data",
      "data": ""
    }

{
    "name": string,
    "gender": boolean,      // true for male, false for female
    "age": int32,
    "address": string,
    "phone": string,
    "email": string
  }

{
      "message": "ok",
      "data": ""
    }

{
      "message": "can not update data",
      "data": ""
    }

{
      "message": "ok",
      "data": ""
    }

{
      "message": "can not delete data",
      "data": ""
    }

{
      "message": "invalid token, please login again",
      "data": ""
    }