Django OpenAPI request/response factories

Author: p1c2u

openapi_core/contrib/django/__init__.py

@@ -0,0 +1,11 @@
+from openapi_core.contrib.django.requests import DjangoOpenAPIRequestFactory
+from openapi_core.contrib.django.responses import DjangoOpenAPIResponseFactory
+
+# backward compatibility
+DjangoOpenAPIRequest = DjangoOpenAPIRequestFactory.create
+DjangoOpenAPIResponse = DjangoOpenAPIResponseFactory.create
+
+__all__ = [
+    'DjangoOpenAPIRequestFactory', 'DjangoOpenAPIResponseFactory',
+    'DjangoOpenAPIRequest', 'DjangoOpenAPIResponse',
+]

openapi_core/contrib/django/requests.py

@@ -0,0 +1,51 @@
+"""OpenAPI core contrib django requests module"""
+import re
+
+from openapi_core.validation.request.datatypes import (
+    RequestParameters, OpenAPIRequest,
+)
+
+# https://docs.djangoproject.com/en/2.2/topics/http/urls/
+#
+# Currently unsupported are :
+#   - nested arguments, e.g.: ^comments/(?:page-(?P<page_number>\d+)/)?$
+#   - unnamed regex groups, e.g.: ^articles/([0-9]{4})/$
+#   - multiple named parameters between a single pair of slashes
+#     e.g.: <page_slug>-<page_id>/edit/
+#
+# The regex matches everything, except a "/" until "<". Than only the name
+# is exported, after which it matches ">" and everything until a "/".
+PATH_PARAMETER_PATTERN = r'(?:[^\/]*?)<(?:(?:.*?:))*?(\w+)>(?:[^\/]*)'
+
+
+class DjangoOpenAPIRequestFactory(object):
+
+    path_regex = re.compile(PATH_PARAMETER_PATTERN)
+
+    @classmethod
+    def create(cls, request):
+        method = request.method.lower()
+
+        if request.resolver_match is None:
+            path_pattern = request.path
+        else:
+            route = cls.path_regex.sub(
+                r'{\1}', request.resolver_match.route)
+            path_pattern = '/' + route
+
+        path = request.resolver_match and request.resolver_match.kwargs or {}
+        parameters = RequestParameters(
+            path=path,
+            query=request.GET,
+            header=request.headers,
+            cookie=request.COOKIES,
+        )
+        return OpenAPIRequest(
+            host_url=request._current_scheme_host,
+            path=request.path,
+            method=method,
+            path_pattern=path_pattern,
+            parameters=parameters,
+            body=request.body,
+            mimetype=request.content_type,
+        )

openapi_core/contrib/django/responses.py

@@ -0,0 +1,14 @@
+"""OpenAPI core contrib django responses module"""
+from openapi_core.validation.response.datatypes import OpenAPIResponse
+
+
+class DjangoOpenAPIResponseFactory(object):
+
+    @classmethod
+    def create(cls, response):
+        mimetype = response["Content-Type"]
+        return OpenAPIResponse(
+            data=response.content,
+            status_code=response.status_code,
+            mimetype=mimetype,
+        )

openapi_core/validation/request/datatypes.py

@@ -21,6 +21,23 @@ def __getitem__(self, location):
 
 @attr.s
 class OpenAPIRequest(object):
+    """OpenAPI request dataclass.
+
+    Attributes:
+        path
+            Requested path as string.
+        path_pattern
+            The matched url pattern.
+        parameters
+            A RequestParameters object.
+        body
+            The request body, as string.
+        mimetype
+            Like content type, but without parameters (eg, without charset,
+            type etc.) and always lowercase.
+            For example if the content type is "text/HTML; charset=utf-8"
+            the mimetype would be "text/html".
+    """
 
     host_url = attr.ib()
     path = attr.ib()

openapi_core/validation/response/datatypes.py

@@ -6,6 +6,16 @@
 
 @attr.s
 class OpenAPIResponse(object):
+    """OpenAPI request dataclass.
+
+    Attributes:
+        data
+            The response body, as string.
+        status_code
+            The status code as integer.
+        mimetype
+            Lowercase content type without charset.
+    """
 
     data = attr.ib()
     status_code = attr.ib()

openapi_core/wrappers/django.py

@@ -2,4 +2,5 @@ mock==2.0.0
 pytest==3.5.0
 pytest-flake8
 pytest-cov==2.5.1
-flask
+flask
+django==2.2.6

requirements_dev.txt

@@ -43,6 +43,7 @@ exclude =
     tests
 
 [options.extras_require]
+django = django
 flask = werkzeug
 
 [tool:pytest]