Skip to main content

DjangoRestFramework API checker

Project description

DRF API Checker

pypi-version travis-png-m rtd-badge codecov-badge

This module offers some utilities to avoid unwanted changes in Django Rest Framework responses, so to keep stable contracts

The purpose is to guarantee that any code changes never introduce 'contract violations' changing the Serialization behaviour.

Contract violations can happen when:

  • fields are removed from Serializer
  • field representation changes (ie. date/number format, )
  • Response status code changes (optional check)
  • Response headers change (optional check)

How it works:

First time the test run, the response and model instances are serialized and saved on the disk; any further execution is checked against this first response.

Test data are saved in the same directory where the test module lives, under _api_checker/<module_fqn>/<test_class>

Fields that cannot be checked by value (ie timestamps/last modified) can be tested writing custom assert_<field_name> methods.

In case of nested objects, method names must follow the field "path". (ie. assert_permission_modified vs assert_modified)

This module can also intercept when a field is added, in this case it is mandatory recreate stored test data; simply delete them from the disk or set API_CHECKER_RESET environment variable and run the test again,

in case something goes wrong the output will be

Field values mismatch

AssertionError: View `<class ''>` breaks the contract.
Field `name` does not match.
- expected: `Partner 0`
- received: `Partner 11`

Field removed

AssertionError: View `<class ''>` breaks the contract.
Field `id` is missing in the new response

Field added

AssertionError: View `<class ''>` returned more field than expected.
Action needed api_customers.response.json need rebuild.
New fields are:

How To use it:


Using ApiCheckerMixin::

class TestAPIAgreements(ApiCheckerMixin, TestCase):
    def get_fixtures(self):
        return {'customer': CustomerFactory()}

    def test_customer_detail(self):
        url = reverse("customer-detail", args=[self.get_fixture('customer').pk])

Using ApiCheckerBase metaclass

class TestAPIIntervention(TestCase, metaclass=ApiCheckerBase):
    URLS = [
            reverse("intervention-detail", args=[101]),

    def get_fixtures(cls):
        return {'intervention': InterventionFactory(id=101),
           'result': ResultFactory(),

ApiCheckerBase can produce API test with minimum effort but it offers less flexibility than ApiCheckerMixin.


pytest integration is provided by two helpers frozenfixture and contract::

from django.urls import reverse
from drf_api_checker.pytest import contract, frozenfixture

def frozen_detail(db):
    from demo.factories import DetailFactory
    return DetailFactory()

def test_url(frozen_detail):
    url = reverse("master-list")
    return url

Custom checks:

Sometimes it is not possible to check a field by value but exists anyway a mechanism to check the contract (ie. timestamp field - ignore for this example tools like freezegun)

To handle this situations you can write custom Recorder with specia asserters:

from drf_api_checker.recorder import Recorder

class TimestampRecorder(Recorder):

    def assert_last_modify_date(self, response: Response, stored: Response, path: str):
        value = response['last_modify_date']
        assert datetime.datetime.strptime(value, '%Y-%m-%dT%H:%M:%S.%fZ')

custom asserter is a method named assert_<field_name>, in case of nested serializers you can have more specific asserter using assert_<fk_field_name>_<field_name>


Develop travis-png-d
Master travis-png-m
Project home page:
Issue tracker:

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for drf-api-checker, version 0.8.1
Filename, size File type Python version Upload date Hashes
Filename, size drf-api-checker-0.8.1.tar.gz (16.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page