How to configure nested ApiControllers

[mcguigon0033]

In django-ninja you can define Router following this documentation: https://django-ninja.dev/guides/routers/#nested-routers

I am curious if the same functionality is available the django-ninja-extra ControllerBase class. How can I nest a ControllerBase under another ControllerBase to achieve the following URL structure:

/api/modelA/ -> List all ModelA objects
/api/modelA/<id>/ -> Get single ModelA object
/api/modelA/<id>/modelB/ -> List all ModelB objects related to ModelA
/api/modelA/<id>/modelB/<id>/ -> Get single ModelB object related to ModelA

[eadwinCode]

You can combine controllers to achieve that but not in a nested fashion.

from ninja_extra import NinjaExtraAPI, api_controller, http_get, ControllerBase
api = NinjaExtraAPI()


@api_controller("/modela")
class ModelAController(ControllerBase):
    @http_get("/")
    def index(self):
        return {"message": "List all ModelA objects"}

    @http_get("/{id}/")
    def get_model_a_by_id(self):
        return {"message": "Get single ModelA object"}


@api_controller("/modela/{a_id}/modelb")
class ModelAModelBController(ControllerBase):
    @http_get("/")
    def index(self, a_id: int):
        return {"message": f"List all ModelB objects related to ModelA by {a_id}"}

    @http_get("/{b_id}/")
    def get_model_b_by_id(self, a_id: int, b_id: int):
        return {"message": f"Get single ModelB={b_id} object related to ModelA={a_id}"}


api.register_controllers(ModelAController, ModelAModelBController)

In api_controller, if you pass a path parameter as a prefix as shown in ModelAModelBController, it is passed down to all the route functions registered under that controller

[eadwinCode]

I will still look into adding nested controller but for now, I think this works

[mcguigon0033]

Thank you. Another helpful thing would be methods/functions to get the Django Object whose primary key is {a_id} in ModelAModelBController.

[eadwinCode]

Do you mean Model Object whose key is a_id?

[mcguigon0033]

Yes, as if the models were a Parent(ModelA) - Child(ModelB) relationship

[eadwinCode]

@api_controller("/modela/{a_id}/modelb")
class ModelAModelBController(ControllerBase):
    @http_get("/")
    def index(self, a_id: int):
        modela = self.get_object_or_exception(ModelA, id=a_id, error_message="ModelA is not found")
        return {"message": f"List all ModelB objects related to ModelA by {a_id}"}

    @http_get("/{b_id}/")
    def get_model_b_by_id(self, a_id: int, b_id: int):
        modela = self.get_object_or_exception(ModelA, id=a_id, error_message="ModelA is not found")
        return {"message": f"Get single ModelB={b_id} object related to ModelA={a_id}"}