Add @endpoint.response_model

apphelpers/rest/endpoint.py

@@ -46,3 +46,11 @@ def not_found_on_none(func):
 def ignore_site_ctx(func):
     func.ignore_site_ctx = True
     return func
+
+
+def response_model(response_model):
+    def decorator(func):
+        func.response_model = response_model
+        return func
+
+    return decorator

apphelpers/rest/fastapi.py

@@ -1,5 +1,6 @@
 import inspect
 from functools import wraps
+from types import NoneType, UnionType
 
 from converge import settings
 from fastapi import APIRouter, Depends
@@ -22,6 +23,12 @@
     from honeybadger.utils import filter_dict
 
 
+def _is_optional(t) -> bool:
+    return (
+        isinstance(t, UnionType) and len(t.__args__) == 2 and t.__args__[1] == NoneType
+    )
+
+
 def raise_not_found_on_none(f):
     if getattr(f, "not_found_on_none", None) is True:
 
@@ -470,17 +477,22 @@ def build(self, method, method_args, method_kw, f):
         module = f.__module__.split(".")[-1].strip("_")
         name = f.__name__.strip("_")
         return_type = inspect.signature(f).return_annotation
+        response_model = getattr(f, "response_model", return_type)
 
         if "operation_id" not in method_kw:
             method_kw["operation_id"] = f"{name}_{module}"
         if "tags" not in method_kw:
             method_kw["tags"] = [module]
+
         if (
             "response_model" not in method_kw
             and "response_class" not in method_kw
-            and return_type is not inspect.Signature.empty
+            and response_model is not inspect.Signature.empty
         ):
-            method_kw["response_model"] = return_type
+            method_kw["response_model"] = response_model
+
+        if _is_optional(return_type) and not _is_optional(response_model):
+            f.not_found_on_none = True
 
         print(
             f"{method_args[0]}",