created structure of users api

Author: astratakis

app/src/routes/users.py

@@ -1,6 +1,11 @@
 from apiflask import APIBlueprint
+from flask import g, request
 
-users_bp = APIBlueprint(
+import uuid
+import schema
+import datetime
+
+users = APIBlueprint(
     "users_blueprint",
     __name__,
     tag={
@@ -10,6 +15,78 @@
 )
 
 
-@users_bp.route("/api/v1/users")
+@users.before_request
+def assign_request_id():
+    g.request_id = request.headers.get("X-Request-ID", str(uuid.uuid4()))
+
+
+@users.after_request
+def add_request_id_to_response(response):
+    response.headers["X-Request-ID"] = g.request_id
+    return response
+
+
+@users.route("/", methods=["GET"])
+@users.output(schema.GenericResponse, status_code=200)
 def api_get_users():
     pass
+
+
+@users.route("/", methods=["POST"])
+@users.output(schema.GenericResponse, status_code=200)
+def api_post_user():
+    pass
+
+
+@users.route("/token", methods=["POST"])
+@users.input(schema.Authentication, location="json")
+@users.output(schema.GenericResponse, status_code=200)
+def api_post_users_token(json: dict):
+    """
+    Generate an OAuth2.0 token for an existing user.
+
+    Returns:
+        - A JSON response with the OAuth2.0 token.
+    """
+
+    username = json.get("username")
+    password = json.get("password")
+
+    token = ""
+
+    if token:
+        return {
+            "url": request.url,
+            "success": True,
+            "id": g.request_id,
+            "version": "v1",
+            "timestamp": datetime.datetime.now(),
+            "data": {"token": token},
+        }, 200
+    else:
+        return {
+            "url": request.url,
+            "success": False,
+            "id": g.request_id,
+            "version": "v1",
+            "timestamp": datetime.datetime.now(),
+            "error": {"name": "Unauthorized", "msg": "Invalid username or password."},
+        }, 401
+
+
+@users.route("/<user_id>", methods=["GET"])
+@users.output(schema.GenericResponse, status_code=200)
+def api_get_user():
+    pass
+
+
+@users.route("/<user_id>", methods=["PATCH"])
+@users.output(schema.GenericResponse, status_code=200)
+def api_patch_user():
+    pass
+
+
+@users.route("/<user_id>", methods=["DELETE"])
+@users.output(schema.GenericResponse, status_code=200)
+def api_delete_user():
+    pass

app/src/schema.py

@@ -0,0 +1,52 @@
+import json
+import logging
+from apiflask import Schema, abort
+from apiflask.fields import Boolean, Integer, String, DateTime, Dict, List, URL
+from apiflask.validators import Length, OneOf, Regexp, Range
+from marshmallow import (
+    pre_load,
+    fields,
+    INCLUDE,
+    validates,
+    post_dump,
+    ValidationError,
+    validate,
+    validates_schema,
+)
+
+__version__ = "v1"
+
+
+class GenericResponse(Schema):
+    url = fields.URL(required=True)
+    success = fields.Boolean(required=True)
+    version = fields.String(required=True)
+    timestamp = fields.DateTime(required=True)
+    id = fields.String(required=True)
+
+    data = fields.Dict(required=False)
+    error = fields.Dict(required=False)
+
+    class Meta:
+        unknown = INCLUDE
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+    def validate(self, data):
+        """
+        Custom validation to ensure either 'result' or 'error' is present
+        based on the 'success' value.
+        """
+        if data.get("success"):
+            if not data.get("data"):
+                raise ValueError("'data' field is required when success is True.")
+        else:
+            if not data.get("error"):
+                raise ValueError("'error' field is required when success is False.")
+        return data
+
+
+class Authentication(Schema):
+    username = fields.String(required=True)
+    password = fields.String(required=True)