Merge pull request #126 from clarkenciel/fix/handle-uuid-as-string

Add UUID parameter type

sanic_openapi/doc.py

@@ -1,3 +1,4 @@
+import uuid
 from collections import defaultdict
 from datetime import date, datetime
 
@@ -110,6 +111,11 @@ def serialize(self):
         return {"type": "array", "items": items, **super().serialize()}
 
 
+class UUID(Field):
+    def serialize(self):
+        return {"type": "string", "format": "uuid", **super().serialize()}
+
+
 definitions = {}
 
 
@@ -169,6 +175,8 @@ def serialize_schema(schema):
             return Date().serialize()
         elif schema is datetime:
             return DateTime().serialize()
+        elif schema is uuid.UUID:
+            return UUID().serialize()
         else:
             return Object(schema).serialize()
 

tests/test_fields.py

@@ -1,8 +1,8 @@
 from datetime import date, datetime
 
-import pytest
-from sanic.response import text
+from sanic.response import HTTPResponse, text
 
+import pytest
 from sanic_openapi import doc
 
 
@@ -248,6 +248,50 @@ def test(request):
     }
 
 
+def test_uuid_field(app):
+    field = doc.UUID()
+    assert field.serialize() == {"type": "string", "format": "uuid"}
+
+    @app.get("/<id:uuid>")
+    @doc.response(204, {})
+    def test(request):
+        return HTTPResponse(status=204)
+
+    _, response = app.test_client.get("/swagger/swagger.json")
+    assert response.status == 200
+    assert response.content_type == "application/json"
+
+    swagger_json = response.json
+    path = swagger_json["paths"]["/{id}"]["get"]
+    assert path["parameters"][0] == {
+        "in": "path",
+        "name": "id",
+        "type": "string",
+        "format": "uuid",
+        "required": True,
+    }
+
+    @app.get("/")
+    @doc.consumes(field, location="formData", required=True)
+    @doc.response(204, {})
+    def test(request):
+        return HTTPResponse(status=204)
+
+    _, response = app.test_client.get("/swagger/swagger.json")
+    assert response.status == 200
+    assert response.content_type == "application/json"
+
+    swagger_json = response.json
+    path = swagger_json["paths"]["/"]["get"]
+    assert path["parameters"][0] == {
+        "in": "formData",
+        "name": None,
+        "type": "string",
+        "format": "uuid",
+        "required": True,
+    }
+
+
 class TestSchema:
     pass