Skip to content

lucasleys/API_Project

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

API Project

A list of contents

Intro

This repository contains my Colruyt api. I choose this subject because i work at colruyt as a student. This is not the only reason, during the periods that i work there i consumed a lot of knowledge about the products. So it was easy to implement this in an api.

Function

First of all, because python is an easy language to learn, i choose to program my api in python and made use of that FastAPI library. In order to get it to be accessible in the cloud i made use of okteto that uses an image build by docker and hosted it through okteto. The api features 2 GET and 1 POST endpoints. You can see if there is a colruyt nearby your location, you just need to fill in your zip-code and the nearest location will bee given. You can also search for products based of the category, you fill in a category and all products available in that category will be displayed with the product name, category and price. If you want to add a new product that is not available in our stores that you would really like to be present. You can request which product needs to be added.

Backend

If you want to get access to the backend of the api, it is possible through the link below:
Link: https://api-lucasleys.cloud.okteto.net
In case that the api backend does not work anymore could be related to the api entering sleep mode. So if this happened, give me a heads up!

Frontend

It is easier to communicate through a frontend with an api. So i made one using ALpineJS and it's available at: https://lucasleys.github.io/API_Project In case of the frontend being down, you can find a screen below: image

Postman screenshots

  • Screen of the result when the api is used for giving the nearest branch location through postman.
    image
  • Screen of the result when the api fails to provide the nearest branch location through postman.
    image
  • Screen of the result when the api is used for searching products based on category through postman. image
  • Screen of the result when the api fails to provide products based on category through postman. image
  • Screen of the result when the api is used for adding a wanted product through postman. image
  • Screen of the result when the api fails to add a new product through postman. image

API docs screenshots

  • Screen of the result when the docs api is used for giving the nearest branch location.
    image
  • Screen of the result when the docs api fails to provide the nearest branch location.
    image
  • Screen of the result when the docs api is used for searching products based on category. image
  • Screen of the result when the docs api fails to provide products based on category. image
  • Screen of the result when the docs api is used for adding a wanted product. image
  • Screen of the result when the docs api fails to add a new product. image

Author

Lucas Leys email

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published