added support for endpoint return type as response type

Author: eadwinCode

.github/workflows/publish.yml

@@ -13,7 +13,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: 3.6
+          python-version: 3.8
       - name: Install Flit
         run: pip install flit
       - name: Install Dependencies
@@ -24,4 +24,4 @@ jobs:
           FLIT_PASSWORD: ${{ secrets.FLIT_PASSWORD }}
         run: flit publish
       - name: Deploy Documentation
-        run: make doc-deploy
+        run: make doc-deploy

ninja_extra/controllers/route/__init__.py

@@ -1,5 +1,5 @@
 import inspect
-from typing import Any, Callable, List, Optional, Type, Union, cast
+from typing import Any, Callable, List, Optional, Type, Union, cast, get_type_hints
 
 from ninja.constants import NOT_SET
 from ninja.signature import is_async
@@ -125,6 +125,8 @@ def _create_route_function(
         include_in_schema: bool = True,
         permissions: Optional[List[Type[BasePermission]]] = None,
     ) -> RouteFunction:
+        if response is NOT_SET:
+            response = get_type_hints(view_func).get("return") or NOT_SET
         route_obj = cls(
             view_func,
             path=path,

pyproject.toml

@@ -35,6 +35,7 @@ classifiers = [
     "Framework :: Django :: 3.1",
     "Framework :: Django :: 3.2",
     "Framework :: Django :: 4.0",
+    "Framework :: Django :: 4.1",
     "Framework :: AsyncIO",
     "Topic :: Internet :: WWW/HTTP :: HTTP Servers",
     "Topic :: Internet :: WWW/HTTP",
@@ -72,7 +73,8 @@ doc = [
     "mkdocs-material >=7.1.9,<8.0.0",
     "mdx-include >=1.4.1,<2.0.0",
     "mkdocs-markdownextradata-plugin >=0.1.7,<0.3.0",
-    "markdown-include"
+    "markdown-include",
+    "mkdocstrings"
 ]
 
 dev = [

tests/controllers.py

@@ -45,7 +45,12 @@ def list_events(self):
     def list_events_example_2(self):
         return list(Event.objects.all())
 
-    @http_get("/{int:id}", response=EventSchema)
-    def get_event(self, id: int):
+    @http_get("/{int:id}")
+    def get_event(self, id: int) -> EventSchema:
         event = get_object_or_404(Event, id=id)
         return event
+
+    @http_get("/{int:id}/from-orm")
+    def get_event_from_orm(self, id: int) -> EventSchema:
+        event = get_object_or_404(Event, id=id)
+        return EventSchema.from_orm(event)

tests/schemas.py

@@ -0,0 +1,6 @@
+from pydantic import BaseModel
+
+
+class UserSchema(BaseModel):
+    name: str
+    age: int

tests/test_controller.py

@@ -4,7 +4,6 @@
 import django
 import pytest
 from django.contrib.auth.models import Group
-from pydantic import UUID4, BaseModel
 
 from ninja_extra import (
     NinjaExtraAPI,
@@ -19,14 +18,10 @@
 from ninja_extra.controllers.response import Detail, Id, Ok
 from ninja_extra.permissions.common import AllowAny
 
+from .schemas import UserSchema
 from .utils import AsyncFakeAuth, FakeAuth
 
 
-class UserSchema(BaseModel):
-    name: str
-    age: int
-
-
 @api_controller
 class SomeController:
     pass

tests/test_event_controller.py

@@ -49,13 +49,20 @@ def test_list_events_works(self):
         ]
         assert event_schema == data
 
-    def test_get_event_works(self):
+    @pytest.mark.parametrize(
+        "path",
+        [
+            "/{event_id}",
+            "/{event_id}/from-orm",
+        ],
+    )
+    def test_get_event_works(self, path):
         object_data = self.dummy_data.copy()
         object_data.update(title=f"{object_data['title']}_get")
 
         event = Event.objects.create(**object_data)
         client = TestClient(EventController)
-        response = client.get(f"/{event.id}")
+        response = client.get(path.format(event_id=event.id))
         assert response.status_code == 200
         data = response.json()
         event_schema = json.loads(EventSchema.from_orm(event).json())

tests/test_route.py

@@ -4,14 +4,14 @@
 import pytest
 from django.contrib.auth.models import AnonymousUser, User
 from ninja import Schema
+from ninja.constants import NOT_SET
 
 from ninja_extra import api_controller, permissions, route
 from ninja_extra.controllers import (
     AsyncRouteFunction,
     Detail,
     Id,
     Ok,
-    Route,
     RouteFunction,
     RouteInvalidParameterException,
 )
@@ -20,6 +20,7 @@
 from ninja_extra.exceptions import PermissionDenied
 from ninja_extra.permissions import AllowAny
 
+from .schemas import UserSchema
 from .utils import FakeAuth
 
 anonymous_request = Mock()
@@ -71,6 +72,10 @@ def example_list_create(self, ex_id: str):
     def example_post_operation_id(self):
         pass
 
+    @route.get("/example/return-response-as-schema")
+    def function_return_as_response_schema(self) -> UserSchema:
+        pass
+
 
 class TestControllerRoute:
     @pytest.mark.parametrize(
@@ -114,6 +119,14 @@ def test_controller_route_should_right_view_func_type(self):
             == SomeTestController.example
         )
 
+    def test_controller_route_should_use_userschema_as_response(self):
+        route_function: RouteFunction = SomeTestController.example
+        assert route_function.route.route_params.response == NOT_SET
+        route_function: RouteFunction = (
+            SomeTestController.function_return_as_response_schema
+        )
+        assert route_function.route.route_params.response == UserSchema
+
     def test_route_generic_invalid_parameters(self):
         with pytest.raises(RouteInvalidParameterException) as ex: