An open API service indexing awesome lists of open source software.

https://github.com/jean0t/shop-api

This is the implementation of a REST API in Flask
https://github.com/jean0t/shop-api

backend-api flask flask-api flask-backend flask-sqlalchemy python3

Last synced: 9 days ago
JSON representation

This is the implementation of a REST API in Flask

Awesome Lists containing this project

README

          

# SHOP API

This project is an API made to manage Stores, in this case you can add Items to a certain store and request the info later. It was made as an exercise to practice Docker and Flask to create a complete REST API.

## Installation

1. Build the docker image `docker build -t shop-api`
2. Run the image and access within your localhost `docker run -p 5000:5000 shop-api`

## Usage

You can go to `localhost:5000/swagger-ui` to see the paths accepted and the methods used.
The documentation also included the objects returned and accepted.

## License

mit © 2025 jean0t

## Contributions

Contributors are welcome, may it be forks or pull requests!