Section 7.5 - API Versioning

packages/ml_api/VERSION

@@ -0,0 +1 @@
+0.2.0

packages/ml_api/api/__init__.py

@@ -0,0 +1,4 @@
+from api.config import PACKAGE_ROOT
+
+with open(PACKAGE_ROOT / 'VERSION') as version_file:
+    __version__ = version_file.read().strip()

packages/ml_api/api/controller.py

@@ -1,7 +1,9 @@
 from flask import Blueprint, request, jsonify
 from regression_model.predict import make_prediction
+from regression_model import __version__ as _version
 
 from api.config import get_logger
+from api import __version__ as api_version
 
 _logger = get_logger(logger_name=__name__)
 
@@ -16,6 +18,13 @@ def health():
         return 'ok'
 
 
+@prediction_app.route('/version', methods=['GET'])
+def version():
+    if request.method == 'GET':
+        return jsonify({'model_version': _version,
+                        'api_version': api_version})
+
+
 @prediction_app.route('/v1/predict/regression', methods=['POST'])
 def predict():
     if request.method == 'POST':

packages/ml_api/tests/test_controller.py

@@ -5,6 +5,8 @@
 import json
 import math
 
+from api import __version__ as api_version
+
 
 def test_health_endpoint_returns_200(flask_test_client):
     # When
@@ -14,6 +16,17 @@ def test_health_endpoint_returns_200(flask_test_client):
     assert response.status_code == 200
 
 
+def test_version_endpoint_returns_version(flask_test_client):
+    # When
+    response = flask_test_client.get('/version')
+
+    # Then
+    assert response.status_code == 200
+    response_json = json.loads(response.data)
+    assert response_json['model_version'] == _version
+    assert response_json['api_version'] == api_version
+
+
 def test_prediction_endpoint_returns_prediction(flask_test_client):
     # Given
     # Load the test data from the regression_model package