Optic is easy to use with Django, no special library or large code changes required.
api start Command#
Let's say we have a simple Django server that we usually develop with on localhost:3005.
Our optic.yml file would include our start command (such as
python manage.py runserver).
Optic injects a
$PORT environment variable for our application to listen on when
api start is run. Wherever you start your API server, set the port on which it will bind with this environment variable:
api check start#
The setup tool will guide you through running checks to assure Optic is running successfully with your API project. You should see everything pass at this point. If you don't, it's most likely that you're not starting the API on the
$PORT Optic provides. The Optic check will also report any other common issues it detects and give you steps and suggestions to resolve them.
At this point you should be ready to run
api start and document your API with Optic! Optic will observe your API traffic locally, and report on the routes and traffic shape it sees in the Optic dashboard. The next step is to start building your baseline specification