Repository files navigation

A simple CRUD backend app using Actix-web, Diesel and JWT

• Rust Stable
• Postgres

Or usingDocker

P/s: On Linux distro maybe got error like "= note: /usr/bin/ld: cannot find -lsqlite3"

• Fedora/CentOS
  • Step 1: Find lib by command yum list 'sqlite'
  • Step 2: Run command sudo dnf/yum install libsqlite3x.x86_64 libsqlite3x-devel.x86_64
• Ubuntu/Ubuntu Server
  • Step 1: Run command sudo apt-get install libsqlite3-dev libpq-dev

• Install postgresql and sqlite backend libraries, more detailshere
  • For Windows: Copy all files insidelibs\windows folder to other location (e.gC:\libs). AddPQ_LIB_DIR andSQLITE3_LIB_DIR environment variable with valueC:\libs. Then restart all terminal windows.
  • For Linux: Installlibpq andlibsqlite3 depends on your distribution.
  • For MacOS: Installlibpq using homebrew:brew install libpq
• Renamesecret.key.sample tosecret.key or create your own key by runninghead -c16 /dev/urandom > secret.key incommand line (Linux/UNIX only) and copy to/src folder
• Create a database in postgres cli orpgAdmin tool
• Renamedotenv.sample to.env and update the database connection string inDATABASE_URL key.
• Build with release profile:cargo build --release
• Run release binary in command line/terminal.
  • Windows:target/release/actix-web-rest-api-with-jwt.exe
  • Linux/UNIX:target/release/actix-web-rest-api-with-jwt
• Enjoy! 😄

• Enter into project directory
• Rundocker-compose -f docker-compose.local.yml up for local environmentordocker-compose -f docker-compose.prod.yml up for production environment
• Enjoy! 😄

• I also madeyew-address-book-client, an Address Book Frontendusing yew-rs.
• yew-address-book-client is heavily under in development, currently the web client does not have login/signup page, soif you want to integrate with backend-side, comment this line bellow inmain.rs to disable authentication middleware

  actix-web-rest-api-with-jwt/src/main.rs

  Line 70 in636d6e5

  .wrap(crate::middleware::auth_middleware::Authentication)

curl -X GET -i'http://127.0.0.1:8000/api/ping'

• Response:

  • 200 OK

    pong!

curl -X POST -i'http://127.0.0.1:8000/api/auth/signup' \  -H"Content-Type: application/json" \  --data'{    "username": "user",    "email": "user@email.com",    "password": "4S3cr3tPa55w0rd"  }'

• Request body:

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

• Response

  • 200 OK

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

  • 400 Bad Request

  {"message":"User '{username}' is already registered","data":""}

curl -X POST -H'Content-Type: application/json' -i'http://127.0.0.1:8000/api/auth/login'  \  --data'{"username_or_email":"user",  "password":"4S3cr3tPa55w0rd"}'

• Request body:

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

• Response

  • 200 OK

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

  • 400 Bad Request

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

curl -X POST -H'Content-Type: application/json' \  -H'Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NzcyNTc4NzksImV4cCI6MTU3Nzg2MjY3OSwidXNlciI6ImMiLCJsb2dpbl9zZXNzaW9uIjoiYzUxNWE3NTg3NGYzNGVjNGFmNDJmNWE2M2QxMDVjMGYifQ.B9w6FxFdypb5GCRMKXZ9CZWFxQLFjvmPSusMCtcE-Ac' \  -i'http://127.0.0.1:8000/api/auth/logout'

curl -X GET -H'Content-Type: application/json' \  -H'Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NzU4NzM4MjksImV4cCI6MTU3NjQ3ODYyOSwidXNlciI6ImMiLCJsb2dpbl9zZXNzaW9uIjoiZjU5N2M3MTIxZTExNDBhMGE0ZjE0YmQ4N2NjM2Q4MWUifQ.6qppDfRgOw45eExJ7MUEwpcu3AUXXe9_ifj_mp7k22k' \  -i'http://127.0.0.1:8000/api/address-book'

• Header:

  • Authorization: bearer <token>

• Response

  • 200 OK

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

curl -X GET -H'Content-Type: application/json' \  -H'Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NzU4NzM4MjksImV4cCI6MTU3NjQ3ODYyOSwidXNlciI6ImMiLCJsb2dpbl9zZXNzaW9uIjoiZjU5N2M3MTIxZTExNDBhMGE0ZjE0YmQ4N2NjM2Q4MWUifQ.6qppDfRgOw45eExJ7MUEwpcu3AUXXe9_ifj_mp7k22k' \  -i'http://127.0.0.1:8000/api/address-book/2'

• Param path:

  • id: int32

• Header:

  • Authorization: bearer <token>

• Response

  • 200 OK

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

  • 404 Not Found

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

curl -X GET -H'Content-Type: application/json' \  -H'Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NzU4NzM4MjksImV4cCI6MTU3NjQ3ODYyOSwidXNlciI6ImMiLCJsb2dpbl9zZXNzaW9uIjoiZjU5N2M3MTIxZTExNDBhMGE0ZjE0YmQ4N2NjM2Q4MWUifQ.6qppDfRgOw45eExJ7MUEwpcu3AUXXe9_ifj_mp7k22k' \  -i'http://127.0.0.1:8000/api/address-book/filter?name=foo&sort_by=name&sort_direction=asc&page_num=0&page_size=10'

• Query param:

  • id: int32
  • name: string
  • gender: boolean
  • age: int32
  • address: String
  • phone: string
  • email: string
  • sort_by: string
  • sort_direction: string (ASC or DESC)
  • page_num: int32
  • page_size: int32

• Header:

  • Authorization: bearer <token>

• Response

  • 200 OK

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

curl -X POST -H'Content-Type: application/json' \  -H'Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NzU4NzM4MjksImV4cCI6MTU3NjQ3ODYyOSwidXNlciI6ImMiLCJsb2dpbl9zZXNzaW9uIjoiZjU5N2M3MTIxZTExNDBhMGE0ZjE0YmQ4N2NjM2Q4MWUifQ.6qppDfRgOw45eExJ7MUEwpcu3AUXXe9_ifj_mp7k22k' \  -i'http://127.0.0.1:8000/api/address-book' \  --data'{    "name": "c",    "gender": true,    "age": 32,    "address": "addr",    "phone": "133",    "email": "e@q.com"  }'

• Header:

  • Authorization: bearer <token>

• Request body:

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

• Response

  • 201 Created

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

  • 500 Internal Server Error

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

curl -X PUT -H'Content-Type: application/json' \  -H'Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NzU4NzM4MjksImV4cCI6MTU3NjQ3ODYyOSwidXNlciI6ImMiLCJsb2dpbl9zZXNzaW9uIjoiZjU5N2M3MTIxZTExNDBhMGE0ZjE0YmQ4N2NjM2Q4MWUifQ.6qppDfRgOw45eExJ7MUEwpcu3AUXXe9_ifj_mp7k22k' \  -i'http://127.0.0.1:8000/api/address-book/2' \  --data'{    "name": "b",    "gender": true,    "age": 32,    "address": "addr",    "phone": "133",    "email": "b@q.com"  }'

• Param path:

  • id: int32

• Header:

  • Authorization: bearer <token>

• Request body:

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

• Response

  • 200 OK

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

  • 500 Internal Server Error

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

curl -X DELETE -H'Content-Type: application/json' \  -H'Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NzU4NzM4MjksImV4cCI6MTU3NjQ3ODYyOSwidXNlciI6ImMiLCJsb2dpbl9zZXNzaW9uIjoiZjU5N2M3MTIxZTExNDBhMGE0ZjE0YmQ4N2NjM2Q4MWUifQ.6qppDfRgOw45eExJ7MUEwpcu3AUXXe9_ifj_mp7k22k' \  -i'http://127.0.0.1:8000/api/address-book/2'

• Param path:

  • id: int32

• Header:

  • Authorization: bearer <token>

• Response

  • 200 OK

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

  • 500 Internal Server Error

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

curl -X OPTIONS -i'http://127.0.0.1:8000/api/login' \  -H"Origin: http://example.com" -H"Access-Control-Request-Method: POST"

• Response

  HTTP/1.1 200 OKcontent-length: 0access-control-max-age: 3600access-control-allow-methods: POST,DELETE,GET,PUTaccess-control-allow-origin: *access-control-allow-headers: authorization,content-type,acceptdate: Tue, 07 Jan 2020 15:17:48 GMT

• Invalid or missing token

  • Status code: 401 Unauthorized
  • Response:

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