Skip to main content

Smoke tests for API built with Django Rest Framework

Project description


Smoke tests for API built with Django Rest Framework.

build codecov PyPI version


pip install rest-framework-smoke


Full example located at testproject.testapp.tests

from rest_framework.test import APITestCase

from rest_framework_smoke.tests.mixins import ReadOnlyViewSetTestsMixin
from rest_framework_smoke.tests.schemas import get_object_schema
from testproject.testapp import models

    "id": {"type": ["number"]},
    "name": {"type": ["string"]},

    "id": {"type": ["number"]},
    "name": {"type": ["string"]},
    "task_set": {
        "type": ["array"],
        "minItems": 1,
        "items": get_object_schema(TASK_SCHEMA)

class ProjectViewSetTestCase(ReadOnlyViewSetTestsMixin, APITestCase):
    object_name = 'project'
    basename = 'projects'
    schema = details_schema = PROJECT_SCHEMA
    pagination_schema = None

    def setUpTestData(cls):
        cls.project = models.Project.objects.create(name='project')
        cls.task = models.Task.objects.create(name='task', project=cls.project)

Happy API testing :)

About schema checks

Rest-Framework-Smoke uses jsonschema to validate API response format. When we check format, we should pay attention to:

  • no unexpected properties are found (is so, they are not validated by schema)
  • there are no missing properties (missing properties are not validated)
  • arrays are not empty (because there is nothing to check in empty arrays)
  • all values are not null (because null values mostly are null by default, and other type variants will never appear in schema validation code)

So there are two helpers in rest_framework_smoke.tests.schemas to enforce these constraints (and they are used internally for format tests):

  • get_object_schema
  • get_array_schema

Download files

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

Source Distribution

rest-framework-smoke-0.9.0.tar.gz (12.0 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page