Skip to main content

Document a django API with Optic

Project description

Optic for Django

Optic Proxy Setup

Python APIs built in Django are easy to connect to Optic using our custom middleware. In this tutorial we'll show you how to connect the Optic Documenting Middleware to your Django app so that your integration tests document your code as they execute.

Add the Middleware to your Project

Install the Optic Documenting Middleware using pip

pip3 install optic-document-django

Making the Middleware Run During Testing

Now add the middleware to the settings.py file that configures the Django API. You should put the middleware at the very bottom of the stack.

MIDDLEWARE = [
    'django.middleware.common.CommonMiddleware',
    'optic.DocumentDjango'
]

Using the Middleware in your tests

The Documenting middleware will document all the requests/responses that your tests run. Since it is integrated at the middleware level there's no need to update any of your tests files or fixtures.

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 optic-document-django, version 0.1.4
Filename, size File type Python version Upload date Hashes
Filename, size optic_document_django-0.1.4-py3-none-any.whl (3.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size optic-document-django-0.1.4.tar.gz (2.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page