A simple CRUD backend app using Actix-web, Diesel and JWT
A simple CRUD backend app using Actix-web, Diesel and JWT
Or using Docker
P/s: On Linux distro maybe got error like "= note: /usr/bin/ld: cannot find -lsqlite3"
libs\windows
folder to other location (e.g C:\libs
). Add PQ_LIB_DIR
and SQLITE3_LIB_DIR
environment variable with value C:\libs
. Then restart all terminal windows.libpq
and libsqlite3
depends on your distribution.libpq
using homebrew: brew install libpq
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
folderdotenv.sample
to .env
and update the database connection string in DATABASE_URL
key.cargo build --release
target/release/actix-web-rest-api-with-jwt.exe
target/release/actix-web-rest-api-with-jwt
docker-compose -f docker-compose.local.yml up
for local environment
or docker-compose -f docker-compose.prod.yml up
for production environmentmain.rs
to disable authentication middleware
https://github.com/SakaDream/actix-web-rest-api-with-jwt/blob/636d6e548f60d341c05707a0e5d3f4e1ee02e60a/src/main.rs#L70
localhost:8000
GET /api/ping
: Pingcurl -X GET -i 'http://127.0.0.1:8000/api/ping'
200 OK
pong!
POST /api/auth/signup
: Signupcurl -X POST -i 'http://127.0.0.1:8000/api/auth/signup' \
-H "Content-Type: application/json" \
--data '{
"username": "user",
"email": "[email protected]",
"password": "4S3cr3tPa55w0rd"
}'
Request body:
{
"username": string,
"email": string,
"password": string // a raw password
}
Response
{
"message": "signup successfully",
"data": ""
}
{
"message": "User '{username}' is already registered",
"data": ""
}
POST /api/auth/login
: Logincurl -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
{
"message": "login successfully",
"data": {
"token": string // bearer token
}
}
{
"message": "wrong username or password, please try again",
"data": ""
}
POST /api/auth/logout
: Logoutcurl -X POST -H 'Content-Type: application/json' \
-H 'Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NzcyNTc4NzksImV4cCI6MTU3Nzg2MjY3OSwidXNlciI6ImMiLCJsb2dpbl9zZXNzaW9uIjoiYzUxNWE3NTg3NGYzNGVjNGFmNDJmNWE2M2QxMDVjMGYifQ.B9w6FxFdypb5GCRMKXZ9CZWFxQLFjvmPSusMCtcE-Ac' \
-i 'http://127.0.0.1:8000/api/auth/logout'
GET /api/address-book
: Get all people informationcurl -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:
Response
{
"message": "ok",
"data": [
{
"id": int32,
"name": string,
"gender": boolean, // true for male, false for female
"age": int32,
"address": string,
"phone": string,
"email": string
}
]
}
GET /api/address-book/{id}
: Get person information by idcurl -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:
Header:
Response
{
"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": ""
}
GET /api/address-book/filter
: Filter person informationcurl -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:
Header:
Response
{
"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
}
POST /api/address-book
: Add person informationcurl -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": "[email protected]"
}
'
Header:
Request body:
{
"name": string,
"gender": boolean, // true for male, false for female
"age": int32,
"address": string,
"phone": string,
"email": string
}
Response
{
"message": "ok",
"data": ""
}
{
"message": "can not insert data",
"data": ""
}
PUT /api/address-book/{id}
: Update person information by idcurl -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": "[email protected]"
}
'
Param path:
Header:
Request body:
{
"name": string,
"gender": boolean, // true for male, false for female
"age": int32,
"address": string,
"phone": string,
"email": string
}
Response
{
"message": "ok",
"data": ""
}
{
"message": "can not update data",
"data": ""
}
DELETE /api/address-book/{id}
: Delete person information by idcurl -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:
Header:
Response
{
"message": "ok",
"data": ""
}
{
"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 OK
content-length: 0
access-control-max-age: 3600
access-control-allow-methods: POST,DELETE,GET,PUT
access-control-allow-origin: *
access-control-allow-headers: authorization,content-type,accept
date: Tue, 07 Jan 2020 15:17:48 GMT
Invalid or missing token
{
"message": "invalid token, please login again",
"data": ""
}