/Store-API

Flask RESFTful API built to manage items in a store

Primary LanguagePython

Store-API

Description

This project is implemented using Flask and is a REST API for a store. The endpoints can be used to add items to, fetch item(s) from, edit items in, and delete items from a store. Also names of stores can be added and retrieved from the database using the assigned endpoints.

Installation

  • Ensure you have Python installed on your PC

  • Run the following command in the terminal to create a virtual environment

python -m venv venv
  • Run the following command in the terminal to activate your virtual environment
source venv/Scripts/activate
  • Run the following command in the terminal to install the dependencies in the requirements.txt file
pip install -r requirements.txt

Test the Endpoints

  • Run python app.py to start the server.

  • Test the endpoints using Postman

    • Steps

      1. /register image

      2. /auth image

      3. /item/name [POST] image

      4. /item/name [GET] image

      5. /items [GET] image

      6. /item/name [PUT] image

      7. /item/name [DELETE] image

      8. /store/name [POST] image

      9. /stores [GET] image

      10. /store/name [DELETE] image

      11. /store/name [GET] image

This project is hosted on heroku