review-api

an attempt to learn how to use rust for a web server

Check src/main.rs for all API endpoints.

See review-ssh for a terminal user interface.

Endpoints

https://review-api.fly.dev

Public endpoints
All `GET` endpoints except for `GET /auth`
`POST /users` to create a new user

All other endpoints require authentication. This means the id cookie received from POST /auth needs to be sent with each request. This happens automatically if using a browser.

Example with curl

curl --location --request GET 'https://review-api.fly.dev/auth' \
--header 'Cookie: id=YOUR_SESSION_ID'

/auth

`GET /auth`

Check current user. This shows the email field.

Response body

{
  "id": 1,
  "name": "Kyle",
  "email": "[email protected]",
  "created_at": "2022-11-30T17:05:36.313355Z",
  "updated_at": "2022-11-30T17:05:36.313355Z"
}

`DELETE /auth`

This logs out the user.

204 OK

`POST /auth`

{
  "email": "[email protected]",
  "password": "password"
}

This logs in the user.

Response header

Key	Value
set-cookie	id=YOUR_SESION_ID_COOKIE; Path=/; Secure; HttpOnly;

Response body

{
  "id": 1,
  "name": "Kyle Zheng",
  "email": "[email protected]",
  "created_at": "2022-11-30T20:03:35.554592Z",
  "updated_at": "2022-11-30T20:03:35.554592Z"
}

/users

`GET /users`

Query params

Param	Type	Default
page	0 < integer	1
per_page	0 < integer < 51	10
sort_by	`FIELD.ORDER` FIELD is one of `id`, `name`, `created_at`, `updated_at` ORDER is one of `asc`, `desc`	id.asc

Request body

{
  "results": [
    {
      "id": 1,
      "name": "Kyle",
      "created_at": "2022-11-30T17:05:36.313355Z",
      "updated_at": "2022-11-30T17:05:36.313355Z"
    },
    {
      "id": 3,
      "name": "Loid",
      "created_at": "2022-11-30T17:13:11.250255Z",
      "updated_at": "2022-11-30T17:27:53.894057Z"
    }
  ],
  "page": 1,
  "total_pages": 1,
  "total_results": 2
}

`GET /users/{id}`

Request body

{
  "id": 1,
  "name": "Kyle",
  "created_at": "2022-11-30T17:05:36.313355Z",
  "updated_at": "2022-11-30T17:05:36.313355Z"
}

`POST /users`

This creates a new user.

Request body

{
  "name": "Twilight",
  "email": "[email protected]",
  "password": "password"
}

Response body

{
  "id": 3,
  "name": "Twilight",
  "created_at": "2022-11-30T17:13:11.250255Z",
  "updated_at": "2022-11-30T17:13:11.250255Z"
}

`PATCH /users/{id}`

Request body

All fields are optional.

{
  "name": "Loid",
  "email": "[email protected]"
}

Response body

This shows the email field, because the route is authenticated.

{
  "id": 3,
  "name": "Loid",
  "email": "[email protected]",
  "created_at": "2022-11-30T17:13:11.250255Z",
  "updated_at": "2022-11-30T17:27:53.894057Z"
}

`DELETE /users/{id}`

Response body

{
  "deleted": 1
}

/search

`GET /search/{category}?query=`

Category is Film | Show

This mostly just a wrapper around the The Movie Database (TMDB) API.

https://developers.themoviedb.org/3/search/search-movies

https://developers.themoviedb.org/3/search/search-tv-shows

Query params

Param	Type	Default
page	0 < integer	1
lang	ISO 639-1 value	en-US
year	integer	n/a

Response body

{
  "page": 1,
  "results": [
    {
      "id": 505642,
      "title": "Black Panther: Wakanda Forever",
      "original_title": "Black Panther: Wakanda Forever",
      "original_language": "en",
      "release_date": "2022-11-09",
      "overview": "Queen Ramonda, Shuri, M’Baku, Okoye and the Dora Milaje fight to protect their nation from intervening world powers in the wake of King T’Challa’s death. As the Wakandans strive to embrace their next chapter, the heroes must band together with the help of War Dog Nakia and Everett Ross and forge a new path for the kingdom of Wakanda.",
      "poster_path": "/sv1xJUazXeYqALzczSZ3O6nkH75.jpg"
    }
  ],
  "total_results": 1,
  "total_pages": 1
}

/reviews

`GET /reviews`

Query params

Param	Type	Default
page	0 < integer	1
per_page	0 < integer < 51	10
sort_by	`FIELD.ORDER` FIELD is one of `tmdb_id`, `created_at`, `updated_at` ORDER is one of `asc`, `desc`	updated_at.desc
user_id	user id	n/a
category	`Film` \| `Show`	n/a
tmdb_id	tmdb_id integer	n/a
season	season integer	n/a
status	`Completed` \| `Watching` \| `Dropped` \| `PlanToWatch`	n/a
fun_before	bool	n/a
fun_during	bool	n/a
fun_after	bool	n/a

Response body

{
  "results": [
    {
      "user_id": 1,
      "tmdb_id": 505642,
      "category": "Film",
      "status": "Completed",
      "text": "🙅🏿‍♂️",
      "fun_before": true,
      "fun_during": true,
      "fun_after": true,
      "created_at": "2022-11-30T18:09:58.829342Z",
      "updated_at": "2022-11-30T18:18:00.720356Z"
    }
  ],
  "page": 1,
  "total_pages": 1,
  "total_results": 1
}

`POST /reviews`

Request body

{
  "tmdb_id": 505642,
  "category": "Film",
  "status": "Completed"
}
or
{
  "tmdb_id": 505642,
  "category": "Show",
  "season": 1,
  "status": "Completed"
}

Response body

{
  "user_id": 1,
  "tmdb_id": 505642,
  "category": "Film",
  "status": "Completed",
  "text": "",
  "fun_before": false,
  "fun_during": false,
  "fun_after": false,
  "created_at": "2022-11-30T18:09:58.829342Z",
  "updated_at": "2022-11-30T18:09:58.829342Z"
}

`PATCH /reviews/{category}/{tmdb_id}`

`PATCH /reviews/{category}/{tmdb_id}/{season}`

Request body

All fields are optional.

{
  "status": "Completed",
  "text": "🙅🏿‍♂️",
  "fun_before": true,
  "fun_during": true,
  "fun_after": true
}

Response body

{
  "user_id": 1,
  "tmdb_id": 505642,
  "category": "Film",
  "status": "Completed",
  "text": "🙅🏿‍♂️",
  "fun_before": true,
  "fun_during": true,
  "fun_after": true,
  "created_at": "2022-11-30T18:09:58.829342Z",
  "updated_at": "2022-11-30T18:18:00.720356Z"
}

`DELETE /reviews/{category}/{tmdb_id}`

`DELETE /reviews/{category}/{tmdb_id}/{season}`

Response body

{
  "deleted": 1
}

Checklist

user auth
search movies and shows using TMDB api
add and edit reviews for movies and shows
allow better programmatic access to api
- regeneratable api keys for users?

Based on following examples (and many more)

For basic structure
- https://gill.net.in/posts/auth-microservice-rust-actix-web1.0-diesel-complete-tutorial/#setting-up-diesel-and-creating-our-user-model
For refactor and advanced stuff
- https://cloudmaker.dev/
For diesel
For containerizing
- https://blog.logrocket.com/packaging-a-rust-web-service-using-docker/
- https://hub.docker.com/r/ekidd/rust-musl-builder/
  - Not reading the README caused me to waste an entire day debugging. TLDR include openssl_probe::init_ssl_cert_env_vars(); to make OpenSSL work (for making outward requests).

Run locally

Create `.env` file

Look at .env.sample for template.

Start local databases

sudo service postgresql start

sudo service redis-server start

Check data

sudo -u postgres psql

redis-cli

Local Docker

docker build -t review-api:latest .

# .env.dev should have localhost replaced with host.docker.internal
docker run --rm -p 8080:8080 --env-file .env.dev review-api

Connecting to deployed fly app

https://fly.io/docs/reference/private-networking/#private-network-vpn

Diesel reads DATABASE_URL in .env

check out db

psql -h <hostname> -p <port> -U <username> -d <database>

Name		Name	Last commit message	Last commit date
Latest commit History 28 Commits
migrations		migrations
src		src
.dockerignore		.dockerignore
.env.sample		.env.sample
.gitignore		.gitignore
Cargo.lock		Cargo.lock
Cargo.toml		Cargo.toml
Dockerfile		Dockerfile
README.md		README.md
diesel.toml		diesel.toml
fly.toml		fly.toml

Folders and files

Latest commit

History

Repository files navigation

review-api

Endpoints

/auth

GET /auth

Response body

DELETE /auth

POST /auth

Response header

Response body

/users

GET /users

Query params

Request body

GET /users/{id}

Request body

POST /users

Request body

Response body

PATCH /users/{id}

Request body

Response body

DELETE /users/{id}

Response body

/search

GET /search/{category}?query=

Query params

Response body

/reviews

GET /reviews

Query params

Response body

POST /reviews

Request body

Response body

PATCH /reviews/{category}/{tmdb_id}

PATCH /reviews/{category}/{tmdb_id}/{season}

Request body

Response body

DELETE /reviews/{category}/{tmdb_id}

DELETE /reviews/{category}/{tmdb_id}/{season}

Response body

Checklist

Based on following examples (and many more)

Run locally

Create .env file

Start local databases

Check data

Local Docker

Connecting to deployed fly app

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Uh oh!

Contributors

Uh oh!

Languages

`GET /auth`

`DELETE /auth`

`POST /auth`

`GET /users`

`GET /users/{id}`

`POST /users`

`PATCH /users/{id}`

`DELETE /users/{id}`

`GET /search/{category}?query=`

`GET /reviews`

`POST /reviews`

`PATCH /reviews/{category}/{tmdb_id}`

`PATCH /reviews/{category}/{tmdb_id}/{season}`

`DELETE /reviews/{category}/{tmdb_id}`

`DELETE /reviews/{category}/{tmdb_id}/{season}`

Create `.env` file

Packages