django-swagger-tester 0.2.3

The validate_response function

The validate_response function takes three required inputs:

• response

  description: This should be the response object returned from an API call. Note: Make sure to pass the response object, not the response data, as we need to match both status_code and json to the OpenAPI schema. type: Response

• method

  description: This should be the HTTP method used to get the reponse. type: string example: ‘GET’

• endpoint_url

  description: This should be the resolvable path of your endpoint. type: string example: ‘api/v1/test’

In addition, the function also takes one optional input:

• ignore_case

  description: List of keys for which we will skip case-validation. This can be useful for when you’ve made a conscious decision to, e.g., keep an acronym upper-cased although you have camelCase as a general standard. type: list of strings example: [‘API’,]

Dynamically rendered OpenAPI schema with drf_yasg

The drf_yasg implementation can be imported from its own project folder:

from django_swagger_tester.response_validation.drf_yasg import validate_response

Statically rendered OpenAPI schema

When testing a static schema (located locally in your project), make sure to point to the right file in the PATH setting.

The static schema implementation can be imported from its own project folder:

from django_swagger_tester.response_validation.static_schema import validate_response

Examples

A pytest implementation might look like this:

def test_response_documentation(client):
    response = client.get('api/v1/test/')

    assert response.status_code == 200
    assert response.json() == expected_response

    # Test Swagger documentation
    validate_response(response=response, method='GET', endpoint_url='api/v1/test/', ignore_case=[])

A Django-test implementation might look like this:

class MyApiTest(APITestCase):

    def setUp(self) -> None:
        user, _ = User.objects.update_or_create(username='test_user')
        self.client.force_authenticate(user=user)
        self.path = '/api/v1/test/'

    def test_get_200(self) -> None:
        """
        Verifies that a 200 is returned for a valid GET request to the /test/ endpoint.
        """
        response = self.client.get(self.path, headers={'Content-Type': 'application/json'})
        expected_response = [...]

        self.assertEqual(response.status_code, 200)
        self.assertEqual(response.json(), expected_response)

        # Test Swagger documentation
        validate_response(response=response, method='GET', endpoint_url=self.path)

You can also test more than a single response at the time.

def test_response_documentation(client):
    # 201 - Resource created
    response = client.post('api/v1/test/', data=...)
    validate_response(response=response, method='POST', endpoint_url='api/v1/test/', ignore_case=[])

    # 200 - Idempotency --> if an object exists, return it with a 200 without creating a new resource
    response = client.post('api/v1/test/', data=...)
    validate_response(response=response, method='POST', endpoint_url='api/v1/test/', ignore_case=[])

    # 400 - Bad data
    response = client.post('api/v1/test/', data=bad_data)
    validate_response(response=response, method='POST', endpoint_url='api/v1/test/', ignore_case=[])