Merge pull request #38 from eScienceLab/feat/apiflask

Basic APIFlask integration

Author: douglowe

README.md

@@ -63,5 +63,11 @@ app/
 ## Example Usage
 
 ```
-curl -X POST http://localhost:5001/ro_crates/post/validate_by_id_no_webhook -d "id=1"
+curl -X 'POST' \
+  'http://localhost:5001/ro_crates/validate_by_id_no_webhook' \
+  -H 'accept: application/json' \
+  -H 'Content-Type: application/json' \
+  -d '{
+  "crate_id": "1"
+}'
 ```

app/__init__.py

@@ -6,20 +6,20 @@
 
 import os
 
-from flask import Flask
+from apiflask import APIFlask
 
 from app.celery_worker import make_celery, celery
 from app.ro_crates.routes import ro_crates_bp
 from app.utils.config import DevelopmentConfig, ProductionConfig, make_celery
 
 
-def create_app() -> Flask:
+def create_app() -> APIFlask:
     """
     Creates and configures Flask application.
 
     :return: Flask: A configured Flask application instance.
     """
-    app = Flask(__name__)
+    app = APIFlask(__name__)
     app.register_blueprint(ro_crates_bp, url_prefix="/ro_crates")
 
     # Load configuration:

app/ro_crates/routes/__init__.py

@@ -4,10 +4,12 @@
 # License: MIT
 # Copyright (c) 2025 eScience Lab, The University of Manchester
 
-from flask import Blueprint
+from apiflask import APIBlueprint
 
 from app.ro_crates.routes.post_routes import post_routes_bp
 
-ro_crates_bp = Blueprint("ro_crates", __name__)
+#ro_crates_bp = APIBlueprint("ro_crates", __name__)
 
-ro_crates_bp.register_blueprint(post_routes_bp, url_prefix="/post")
+#ro_crates_bp.register_blueprint(post_routes_bp, url_prefix="/post")
+
+ro_crates_bp = post_routes_bp

app/ro_crates/routes/post_routes.py

@@ -4,51 +4,79 @@
 # License: MIT
 # Copyright (c) 2025 eScience Lab, The University of Manchester
 
-from flask import Blueprint, request, Response
+from apiflask import APIBlueprint, Schema
+from apiflask.fields import Integer, String
+from flask import request, Response
 
 from app.services.validation_service import queue_ro_crate_validation_task
 
-post_routes_bp = Blueprint("post_routes", __name__)
+post_routes_bp = APIBlueprint("post_routes", __name__)
 
+class validate_data(Schema):
+    crate_id = String(required=True)
+    profile_name = String(required=False)
+    webhook_url = String(required=False)
 
-@post_routes_bp.route("/validate_by_id", methods=["POST"])
-def validate_ro_crate_from_id() -> tuple[Response, int]:
-    """
-    Endpoint to validate an RO-Crate using its ID from MinIO. Requires webhook_url.
 
-    :param id: The ID of the RO-Crate to validate. Required.
-    :param profile_name: The profile name for validation. Optional.
-    :param webhook_url: The webhook URL where validation results will be sent. Required.
-    :return: A tuple containing the validation task's response and an HTTP status code.
-    :raises: KeyError: If required parameters (`id` or `webhook_url`) are missing.
+@post_routes_bp.post("/validate_by_id")
+@post_routes_bp.input(validate_data(partial=True), location='json')
+def validate_ro_crate_from_id(json_data) -> tuple[Response, int]:
     """
+    Endpoint to validate an RO-Crate using its ID from MinIO.
 
-    crate_id = request.form.get("id")
-    profile_name = request.form.get("profile_name")
-    webhook_url = request.form.get("webhook_url")
+    Parameters:
+    - **crate_id**: The ID of the RO-Crate to validate. _Required_.
+    - **profile_name**: The profile name for validation. _Optional_.
+    - **webhook_url**: The webhook URL where validation results will be sent. _Required_.
 
-    if not crate_id:
-        raise KeyError("Missing required parameter: 'id'")
-    if not webhook_url:
+    Returns:
+    - A tuple containing the validation task's response and an HTTP status code.
+
+    Raises:
+    - KeyError: If required parameters (`crate_id` or `webhook_url`) are missing.
+    """
+
+    try:
+        crate_id = json_data["crate_id"]
+    except:
+        raise KeyError("Missing required parameter: 'crate_id'")
+    try:
+        webhook_url = json_data["webhook_url"]
+    except:
         raise KeyError("Missing required parameter: 'webhook_url'")
 
-    return queue_ro_crate_validation_task(crate_id, profile_name, webhook_url)
+    try:
+        profile_name = json_data["profile_name"]
+    except:
+        profile_name = None
 
+    return queue_ro_crate_validation_task(crate_id, profile_name, webhook_url)
 
-@post_routes_bp.route("/validate_by_id_no_webhook", methods=["POST"])
-def validate_ro_crate_from_id_no_webhook() -> tuple[Response, int]:
+@post_routes_bp.post("/validate_by_id_no_webhook")
+@post_routes_bp.input(validate_data(partial=True), location='json') # -> json_data
+def validate_ro_crate_from_id_no_webhook(json_data) -> tuple[Response, int]:
     """
-    Endpoint to validate an RO-Crate using its ID from MinIO. Does not require webhook_url.
+    Endpoint to validate an RO-Crate using its ID from MinIO.
+
+    Parameters:
+    - **crate_id**: The ID of the RO-Crate to validate. _Required_.
+    - **profile_name**: The profile name for validation. _Optional_.
 
-    :param id: The ID of the RO-Crate to validate. Required.
-    :param profile_name: The profile name for validation. Optional.
-    :return: A tuple containing the validation task's response and an HTTP status code.
-    :raises: KeyError: If required parameters (`id` or `webhook_url`) are missing.
+    Returns:
+    - A tuple containing the validation task's response and an HTTP status code.
+
+    Raises:
+    - KeyError: If required parameters (`crate_id`) are missing.
     """
-    crate_id = request.form.get("id")
-    profile_name = request.form.get("profile_name")
 
-    if not crate_id:
+    try:
+        crate_id = json_data['crate_id']
+    except:
         raise KeyError("Missing required parameter: 'id'")
 
+    try:
+        profile_name = json_data['profile_name']
+    except:
+        profile_name = None
+
     return queue_ro_crate_validation_task(crate_id, profile_name)

requirements.txt

@@ -5,3 +5,4 @@ Flask~=3.0.3
 Werkzeug~=3.0.4
 redis~=5.2.0
 python-dotenv~=1.0.1
+apiflask~=2.4.0