DetailsAPI

API for Details project

Preparing the enviroment:

• install pyhton 3 on your computer and add it to the path enviroment

• open the project using vs code

• open the terminal on vs code and right the following to create python enviroment with the required dependences:

  1. python -m venv env
  2. pip install --upgrade pip
  3. pip install -r requirements.txt
  4. .\env\Scripts\activate

• now you can run the main.py without problems

• Now go to http://127.0.0.1:9000/docs.

• You will see the automatic interactive API documentation (provided by Swagger UI):

• on this interactive API documentation you can try the API without using external tools like postman

• all the avilable requests types and paths will be shown there and will be ready for testing.

• Example of using the getRFM post request which require a file of the request body for analyzing and returing the analyzed data.

• note that on the Response section there is an example of the output

• Example of the output of analyzing data

• also you can click download to download the JSON file.