Swagger UI Added

Author: MonsefRH

backend/app.py

@@ -18,13 +18,19 @@
 from routes.t5_base import t5_base_bp
 from routes.admin import admin_bp
 
+from flasgger import Swagger
+from utils.api_spec import swagger_template, swagger_config
+
 # Load environment variables
 load_dotenv()
 
 app = Flask(__name__)
 CORS(app)
 bcrypt = Bcrypt(app)
 
+# Initialize Swagger
+swagger = Swagger(app, template=swagger_template,config=swagger_config)
+
 # JWT configuration
 app.config["JWT_SECRET_KEY"] = os.getenv("JWT_SECRET_KEY")
 if not app.config["JWT_SECRET_KEY"]:

backend/requirements.txt

@@ -18,3 +18,5 @@ google-generativeai
 transformers
 torch
 flask_sqlalchemy
+flasgger
+apispec-pydantic-plugin

backend/routes/History.py

@@ -3,10 +3,12 @@
 from schemas.history_dto import ScanHistoryResponse, HistoryErrorResponse
 import logging
 
+from flasgger import swag_from
 history_bp = Blueprint("history", __name__)
 logger = logging.getLogger(__name__)
 
 @history_bp.route("/history", methods=["GET"])
+@swag_from("../specs/history_specs.yml")
 def get_scan_history_route():
     user_id = request.headers.get("X-User-ID")
     scan_type = request.args.get("scan_type")

backend/routes/admin.py

@@ -4,10 +4,12 @@
 from schemas.admin_dto import AdminStatsResponse
 from pydantic import ValidationError
 
+from flasgger import swag_from
 admin_bp = Blueprint("admin", __name__)
 
 @admin_bp.route("/api/admin-stats", methods=["GET"])
 @jwt_required()
+@swag_from("../specs/admin_specs.yml")
 def get_admin_stats_route():
     try:
         user_id = get_jwt_identity()

backend/routes/checkov.py

@@ -5,6 +5,7 @@
 import os
 import logging
 
+from flasgger import swag_from
 checkov_bp = Blueprint("checkov", __name__)
 
 # Configure upload folder
@@ -15,6 +16,7 @@
 logger = logging.getLogger(__name__)
 
 @checkov_bp.route("/checkov", methods=["POST"])
+@swag_from("../specs/checkov_specs.yml")
 def validate():
     try:
         user_id = request.headers.get("X-User-ID") or (request.json and request.json.get("user_id"))

backend/routes/dashboard_routes.py

@@ -2,9 +2,12 @@
 from services.dashboard_service import get_user_stats
 from schemas.dashboard_dto import DashboardStatsResponse, DashboardErrorResponse
 
+from flasgger import swag_from
+
 dashboard_bp = Blueprint("dashboard", __name__)
 
 @dashboard_bp.route("/stats", methods=["GET"])
+@swag_from("../specs/dashboard_specs.yml")
 def get_stats():
     user_id = request.headers.get("X-User-ID")
     if not user_id:

backend/routes/full_scan_routes.py

@@ -5,11 +5,13 @@
 from pydantic import ValidationError
 import logging
 
+from flasgger import swag_from
 full_scan_bp = Blueprint("full_scan", __name__)
 logger = logging.getLogger(__name__)
 
 @full_scan_bp.route("/full-scan", methods=["POST"])
 @jwt_required()
+@swag_from("../specs/full_scan_specs.yml")
 def full_scan():
     try:
         data = FullScanRequest(**request.get_json())

backend/routes/github_routes.py

@@ -5,10 +5,12 @@
 from pydantic import ValidationError
 import logging
 
+from flasgger import swag_from
 github_bp = Blueprint("github", __name__)
 logger = logging.getLogger(__name__)
 
 @github_bp.route("/auth/github")
+@swag_from("../specs/github/auth_github_specs.yml")
 def github_login_route():
     try:
         auth_url = github_login()
@@ -18,6 +20,7 @@ def github_login_route():
         return jsonify(GithubErrorResponse(error=str(e)).dict()), 400
 
 @github_bp.route("/auth/github/callback")
+@swag_from("../specs/github/auth_github_callback_specs.yml")
 def github_callback_route():
     try:
         code = request.args.get("code")
@@ -32,6 +35,7 @@ def github_callback_route():
 
 @github_bp.route("/github/repos", methods=["GET"])
 @jwt_required()
+@swag_from("../specs/github/github_repos_specs.yml")
 def get_github_repos_route():
     try:
         user_id = get_jwt_identity()
@@ -46,6 +50,7 @@ def get_github_repos_route():
 
 @github_bp.route("/github/validate-token", methods=["POST"])
 @jwt_required()
+@swag_from("../specs/github/github_validate_token_specs.yml")
 def validate_github_token_route():
     try:
         user_id = get_jwt_identity()
@@ -64,6 +69,7 @@ def validate_github_token_route():
 
 @github_bp.route("/github/save-repos", methods=["POST"])
 @jwt_required()
+@swag_from("../specs/github/github_save_repos_specs.yml")
 def save_selected_repos_route():
     try:
         user_id = get_jwt_identity()
@@ -88,6 +94,7 @@ def save_selected_repos_route():
 
 @github_bp.route("/github/repo-configs", methods=["GET"])
 @jwt_required()
+@swag_from("../specs/github/github_repo_configs_specs.yml")
 def get_repo_configs_route():
     try:
         user_id = get_jwt_identity()

backend/routes/google_routes.py

@@ -3,10 +3,12 @@
 from schemas.google_dto import GoogleAuthResponse, GoogleCallbackResponse, GoogleErrorResponse
 import logging
 
+from flasgger import swag_from
 google_bp = Blueprint("google", __name__)
 logger = logging.getLogger(__name__)
 
 @google_bp.route("/auth/google", methods=["GET"])
+@swag_from("../specs/google/auth_google_specs.yml")
 def google_login_route():
     try:
         auth_url = google_login()
@@ -16,6 +18,7 @@ def google_login_route():
         return jsonify(GoogleErrorResponse(error=str(e)).dict()), 400
 
 @google_bp.route("/auth/google/callback", methods=["GET"])
+@swag_from("../specs/google/auth_google_callback_specs.yml")
 def google_callback_route():
     try:
         code = request.args.get("code")

backend/routes/risks.py

@@ -3,10 +3,12 @@
 from schemas.risks_dto import RisksResponse, RisksErrorResponse
 import logging
 
+from flasgger import swag_from
 risks_bp = Blueprint("risks", __name__)
 logger = logging.getLogger(__name__)
 
 @risks_bp.route("/risks", methods=["GET"])
+@swag_from("../specs/risks_specs.yml")
 def get_risks_route():
     user_id = request.headers.get("X-User-ID")
     try: