lspaulucio / flask-rest-api

Simple Rest API created with Flask

Flask REST-API

Simple Rest API created with Flask

Dependencies

• Python 3.10.6
• pip3
• docker-compose

Running

Clone the repository

~$ git clone https://github.com/lspaulucio/flask-rest-api.git

Once all dependencies are installed run the following command to install the necessary python packages.

~$ pip3 install -r requirements.txt

On linux terminal, go to project folder and execute the command to start the services:

~$ docker-compose up

(Optional) If you have cmake installed you also can run the following command to start the services:

~$ make compose

Once the services are up, you can access the API's swagger documentation at http://127.0.0.1:5000/api-docs