✨ (Flask-Smorest) Add project for Flask-Smorest section

This project includes items and stores, and uses Docker and Flask-Smorest.

No user authentication and no tags. Items and stores don't have a relationship either, as no database is included in the project. This is purely to show how to use Flask-Smorest.

Author: jslvtr

project/03-items-stores-smorest/.flaskenv

@@ -0,0 +1,2 @@
+FLASK_APP=app
+FLASK_ENV=development

project/03-items-stores-smorest/Dockerfile

@@ -0,0 +1,7 @@
+FROM python:3.10
+EXPOSE 5000
+WORKDIR /app
+COPY ./requirements.txt requirements.txt
+RUN pip install --no-cache-dir --upgrade -r requirements.txt
+COPY . .
+CMD ["flask", "run", "--host", "0.0.0.0"]

project/03-items-stores-smorest/app.py

@@ -0,0 +1,21 @@
+from flask import Flask
+from flask_smorest import Api
+
+from resources.item import blp as ItemBlueprint
+from resources.store import blp as StoreBlueprint
+
+
+app = Flask(__name__)
+
+app.config["PROPAGATE_EXCEPTIONS"] = True
+app.config["API_TITLE"] = "Stores REST API"
+app.config["API_VERSION"] = "v1"
+app.config["OPENAPI_VERSION"] = "3.0.2"
+app.config["OPENAPI_URL_PREFIX"] = "/"
+app.config["OPENAPI_SWAGGER_UI_PATH"] = "/swagger-ui"
+app.config["OPENAPI_SWAGGER_UI_URL"] = "https://cdn.jsdelivr.net/npm/swagger-ui-dist/"
+
+api = Api(app)
+
+api.register_blueprint(ItemBlueprint)
+api.register_blueprint(StoreBlueprint)

project/03-items-stores-smorest/db.py

@@ -0,0 +1,12 @@
+"""
+db.py
+---
+
+Later on, this file will be replaced by SQLAlchemy. For now, it mimics a database.
+Our data storage is:
+    - stores have a unique ID and a name
+    - items have a unique ID, a name, a price, and a store ID.
+"""
+
+stores = {}
+items = {}

project/03-items-stores-smorest/requirements.txt

@@ -0,0 +1,4 @@
+flask
+flask-smorest
+python-dotenv
+marshmallow

project/03-items-stores-smorest/resources/__init__.py

@@ -0,0 +1 @@
+

project/03-items-stores-smorest/resources/item.py

@@ -0,0 +1,61 @@
+import uuid
+from flask.views import MethodView
+from flask_smorest import Blueprint, abort
+
+from schemas import ItemSchema, ItemUpdateSchema
+from db import items
+
+blp = Blueprint("Items", "items", description="Operations on items")
+
+
+@blp.route("/item/<string:item_id>")
+class Item(MethodView):
+    @blp.response(200, ItemSchema)
+    def get(self, item_id):
+        try:
+            return items[item_id]
+        except KeyError:
+            abort(404, message="Item not found.")
+
+    def delete(self, item_id):
+        try:
+            del items[item_id]
+            return {"message": "Item deleted."}
+        except KeyError:
+            abort(404, message="Item not found.")
+
+    @blp.arguments(ItemUpdateSchema)
+    @blp.response(200, ItemSchema)
+    def put(self, item_data, item_id):
+        try:
+            item = items[item_id]
+
+            # https://blog.teclado.com/python-dictionary-merge-update-operators/
+            item |= item_data
+
+            return item
+        except KeyError:
+            abort(404, message="Item not found.")
+
+
+@blp.route("/items")
+class ItemList(MethodView):
+    @blp.response(200, ItemSchema(many=True))
+    def get(self):
+        return items.values()
+
+    @blp.arguments(ItemSchema)
+    @blp.response(201, ItemSchema)
+    def post(self, item_data):
+        for item in items.values():
+            if (
+                item_data["name"] == item["name"]
+                and item_data["store_id"] == item["store_id"]
+            ):
+                abort(400, message=f"Item already exists.")
+
+        item_id = uuid.uuid4().hex
+        item = {**item_data, "id": item_id}
+        items[item_id] = item
+
+        return item

project/03-items-stores-smorest/resources/store.py

@@ -0,0 +1,47 @@
+import uuid
+from flask.views import MethodView
+from flask_smorest import Blueprint, abort
+from db import stores
+from schemas import StoreSchema
+
+
+blp = Blueprint("Stores", "stores", description="Operations on stores")
+
+
+@blp.route("/store/<string:store_id>")
+class Store(MethodView):
+    @blp.response(200, StoreSchema)
+    def get(cls, store_id):
+        try:
+            # You presumably would want to include the store's items here too
+            # More on that when we look at databases
+            return stores[store_id]
+        except KeyError:
+            abort(404, message="Store not found.")
+
+    def delete(cls, store_id):
+        try:
+            del stores[store_id]
+            return {"message": "Store deleted."}
+        except KeyError:
+            abort(404, message="Store not found.")
+
+
+@blp.route("/stores")
+class StoreList(MethodView):
+    @blp.response(200, StoreSchema(many=True))
+    def get(cls):
+        return stores.values()
+
+    @blp.arguments(StoreSchema)
+    @blp.response(201, StoreSchema)
+    def post(cls, store_data):
+        for store in stores.values():
+            if store_data["name"] == store["name"]:
+                abort(400, message=f"Store already exists.")
+
+        store_id = uuid.uuid4().hex
+        store = {**store_data, "id": store_id}
+        stores[store_id] = store
+
+        return store

project/03-items-stores-smorest/schemas.py

@@ -0,0 +1,29 @@
+from marshmallow import Schema, fields
+
+
+class ItemSchema(Schema):
+    id = fields.Str(dump_only=True)
+    name = fields.Str(required=True)
+    price = fields.Float(required=True)
+    store_id = fields.Int(required=True)
+
+
+class ItemWithoutStoreSchema(Schema):
+    id = fields.Str(dump_only=True)
+    name = fields.Str(required=True)
+    price = fields.Float(required=True)
+
+
+class ItemUpdateSchema(Schema):
+    name = fields.Str()
+    price = fields.Float()
+
+
+class StoreSchema(Schema):
+    id = fields.Str()
+    name = fields.Str()
+
+
+class StoreWitoutItemsSchema(Schema):
+    id = fields.Str()
+    name = fields.Str()