leo8198 / gutendexapi

Gutendex API

Running the service

Use docker compose to run the service.

docker compose up

Using the endpoints

Searching a book by name

curl --location --request GET 'http://localhost:5000/api/v1/books?title=A Treatise Concerning'

Create a review about some book

curl --location --request POST 'http://localhost:5000/api/v1/books/84/review' \ --header 'Content-Type: application/json' \ --data-raw '{ "bookId": 84, "rating": 5, "description": "Very good book" }'

Get book details

curl --location --request GET 'http://localhost:5000/api/v1/books/84'

Tests

Run tests using pytest. The docker containers should be UP before you start running the tests. You also should export the following env variable in your current environment (outside the container).

• DATABASE_URL=postgresql://postgres:leotarla@localhost:5432/postgres
  

Now, run the tests:

pytest tests/

Scalable architecture diagram

A high-level scalable architecture diagram can be found here.