The Books API project is a web application that allows for interaction with a book database through a RESTful and Html interface. It provides a set of routes that allow users to easily and quickly retrieve books and configure them.

• Clone repo

  git clone https://gitlab.com/luismendezdev/books-api.git

• Create and activate virtual environment

  • Linux, MacOS

    virtualenv venv
    source venv/bin/activate

  • Windows Powershell

    virtualenv venv
    venv\Scripts\activate.ps1

• Install dependencies

  • Windows Powershell

  pip install -r requirements_dev.txt

• Create a local database using postgresql

• Create .env file and your values for:

  POSTGRES_HOST=<YOUR_POSTGRES_HOST>
  POSTGRES_DB=<YOUR_POSTGRES_DB>
  POSTGRES_USER=<YOUR_POSTGRES_USER>
  POSTGRES_PASSWORD=<YOUR_POSTGRES_PASSWORD>
  POSTGRES_PORT=<YOUR_POSTGRES_PORT>
  SERVER_PORT=<YOUR_SERVER_PORT>

  • Also export:

    export POSTGRES_USER=<YOUR_POSTGRES_USER>
    export POSTGRES_PASSWORD=<YOUR_POSTGRES_PASSWORD>
    export POSTGRES_DB=<YOUR_POSTGRES_DB>
    export POSTGRES_PORT=<YOUR_POSTGRES_PORT>
    export SERVER_PORT=<YOUR_SERVER_PORT>

• Run server

  python main.py

• Add env values into .env and export variables

• Build and start docker

  docker-compose up --build

• Api

• Html

The URLs are validated. If you try to go to a non-existent route, (e.g. /api/books/a-books or /books/hello) it will return a 404 error.