Reference
=========

This page provides links to the public reference documentation for
Django-AWS-API-Gateway-WebSockets.

For most users, start with the user guide pages before using this reference:

* :doc:`quickstart`;
* :doc:`concepts`;
* :doc:`api_gateway_setup`;
* :doc:`client_integration`;
* :doc:`security`.

Public API
----------

* :doc:`models`;
* :doc:`views`;
* :doc:`mixins`.

Operational reference
---------------------

* :doc:`settings`;
* :doc:`management_commands/index`;
* :doc:`admin`.

Usage reference
---------------

* :doc:`message_patterns`;
* :doc:`templates_and_mixins`;
* :doc:`testing`;
* :doc:`upgrade_guide`.

Generated API documentation
---------------------------

* :doc:`api/index`.

Architecture
------------

* :doc:`architecture`.