API Reference
=============

This section contains the complete API reference for Gobstopper framework.

Core Application
----------------

.. automodule:: gobstopper.core.app
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: gobstopper.core.blueprint
   :members:
   :undoc-members:
   :show-inheritance:

HTTP Components
---------------

Request
^^^^^^^

.. automodule:: gobstopper.http.request
   :members:
   :undoc-members:
   :show-inheritance:

Response
^^^^^^^^

.. automodule:: gobstopper.http.response
   :members:
   :undoc-members:
   :show-inheritance:

Background Tasks
----------------

.. automodule:: gobstopper.tasks.queue
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: gobstopper.tasks.models
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: gobstopper.tasks.storage
   :members:
   :undoc-members:
   :show-inheritance:

WebSockets
----------

.. automodule:: gobstopper.websocket.connection
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: gobstopper.websocket.manager
   :members:
   :undoc-members:
   :show-inheritance:

Sessions
--------

.. automodule:: gobstopper.sessions.storage
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: gobstopper.sessions.redis_storage
   :members:
   :undoc-members:
   :show-inheritance:

.. Note: sql_storage requires asyncpg to be installed
   Uncomment when building with postgres support

.. .. automodule:: gobstopper.sessions.sql_storage
..    :members:
..    :undoc-members:
..    :show-inheritance:

Middleware
----------

.. automodule:: gobstopper.middleware.static
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: gobstopper.middleware.cors
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: gobstopper.middleware.security
   :members:
   :undoc-members:
   :show-inheritance:

Templates
---------

.. automodule:: gobstopper.templates.engine
   :members:
   :undoc-members:
   :show-inheritance:

Utilities
---------

.. automodule:: gobstopper.utils.rate_limiter
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: gobstopper.utils.idempotency
   :members:
   :undoc-members:
   :show-inheritance: