Skip to content

Testing APIController

Django Ninja Extra has a TestClient that provides seamless testing of ControllerBase classes with pytest

There are two test clients

  • TestClient: for synchronous route functions
  • TestAsyncClient: for asynchronous route functions

Both TestClient and TestAsyncClient inherit from the Django Ninja TestClient class which provides the base functionality for making requests to the application, and both of them also have similar methods such as get, post, put, patch, delete, and options for making requests to the application.

For example, to test a GET request to the /users endpoint, you can use the TestClient as follows:

import pytest
from .controllers import UserController
from ninja_extra.testing import TestClient

class TestMyMathController:
    def test_get_users(self):
        client = TestClient(UserController)
        response = client.get('/users')
        assert response.status_code == 200
        assert response.json()[0] == {
            'first_name': 'Ninja Extra',
            'username': 'django_ninja',
            'email': ''
Similarly, for testing an asynchronous route function, you can use TestClientAsync as follows:

from ninja_extra import api_controller, route
from ninja_extra.testing import TestAsyncClient

@api_controller('', tags=['Math'])
class MyMathController:
    async def add(self, a: int, b: int):
        """add a to b"""
        return {"result": a - b}

class TestMyMathController:
    def test_get_users_async(self):
        client = TestAsyncClient(MyMathController)
        response = client.get('/add', query=dict(a=3, b=5))
        assert response.status_code == 200
        assert response.json() == {"result": -2}