add Flask-RESTX API structure with OpenAPI documentation (#138)

Author: Flet

app/poetry.lock

@@ -2,14 +2,13 @@
 name = "strelka-ui"
 version = "2.43"
 description = "Strelka's File Submission Portal"
-authors = [
-    "Paul Hutelmyer <Paul.Hutelmyer@Target.com>",
-]
+authors = ["Paul Hutelmyer <Paul.Hutelmyer@Target.com>"]
 
 [tool.poetry.dependencies]
 flask = "^3.1.1"
 flask-Cors = "^6.0.0"
 flask-migrate = "^4.0.7"
+flask-restx = "^1.3.0"
 flask-sqlalchemy = "3.0.5"
 grpcio = "^1.53.2"
 grpcio-tools = "^1.41.0"
@@ -21,7 +20,7 @@ psycopg2-binary = "^2.9.10"
 py7zr = "^0.22.0"
 python = "~3.10.14"
 python-dateutil = "^2.9.0-post.0"
-python-dotenv = "^1.0.1" 
+python-dotenv = "^1.0.1"
 python-magic = "^0.4.27"
 rarfile = "^4.2"
 requests = "^2.32.4"

app/pyproject.toml

@@ -18,6 +18,7 @@
 from strelka_ui.blueprints.strelka import strelka
 from strelka_ui.blueprints.ui import ui
 from strelka_ui.models import db
+from strelka_ui.api import api_blueprint
 
 
 def create_app() -> Flask:
@@ -55,6 +56,9 @@ def create_app() -> Flask:
     app.register_blueprint(auth, url_prefix="/api/auth")
     app.register_blueprint(strelka, url_prefix="/api/strelka")
 
+    # This provides Swagger UI at /api/docs
+    app.register_blueprint(api_blueprint)
+
     return app
 
 

app/strelka_ui/__main__.py

@@ -0,0 +1,43 @@
+"""
+Flask-RESTX API Configuration for Strelka UI
+
+This module sets up the base API structure with namespaces and OpenAPI documentation.
+Auto-generates comprehensive API documentation for external clients.
+"""
+
+from flask import Blueprint
+from flask_restx import Api
+
+# Create API blueprint
+api_blueprint = Blueprint('api', __name__, url_prefix='/api')
+
+# Configure Flask-RESTX API with comprehensive OpenAPI settings
+api = Api(
+    api_blueprint,
+    version='v1',
+    title='Strelka UI API',
+    description='''https://github.com/target/strelka-ui
+    ''',
+    doc='/docs/',  # Swagger UI endpoint
+    contact='Strelka UI Team',
+    license='Apache 2.0',
+    license_url='https://www.apache.org/licenses/LICENSE-2.0.html',
+    validate=True,  # Enable request/response validation
+    ordered=True,   # Maintain endpoint order in documentation
+)
+
+# Security schemes for OpenAPI documentation
+authorizations = {
+    'apikey': {
+        'type': 'apiKey',
+        'in': 'header',
+        'name': 'X-API-KEY',
+        'description': 'API Key for authentication. Obtain via /auth/apikey endpoint.'
+    }
+}
+
+# Apply security schemes to API
+api.authorizations = authorizations
+
+# Import resources to register Flask-RESTX documentation endpoints
+from strelka_ui.api import resources  # pylint: disable=unused-import,import-outside-toplevel