api.integration
===============

.. py:module:: api.integration


Classes
-------

.. autoapisummary::

   api.integration.ApiApp


Functions
---------

.. autoapisummary::

   api.integration.get_api_endpoints


Module Contents
---------------

.. py:class:: ApiApp

   Bases: :py:obj:`morepath.App`


   A Morepath-based application object.

   You subclass App to create a morepath application class. You can
   then configure this class using Morepath decorator directives.

   An application can extend one or more other applications, if
   desired, by subclassing them. By subclassing App itself, you get
   the base configuration of the Morepath framework itself.

   Conflicting configuration within an app is automatically
   rejected. An subclass app cannot conflict with the apps it is
   subclassing however; instead configuration is overridden.

   You can turn your app class into a `WSGI`_ application by instantiating
   it. You can then call it with the ``environ`` and ``start_response``
   arguments.

   .. _`WSGI`: https://www.python.org/dev/peps/pep-3333/

   Subclasses from :class:`dectate.App`, which provides the
   :meth:`dectate.App.directive` decorator that lets you register
   new directives.


   .. py:method:: get_cache(name: str, expiration_time: float) -> onegov.core.cache.RedisCacheRegion


   .. py:method:: configure_api(**cfg: Any) -> None

      Configures the API.

      The following configuration options are accepted:

      :rate_limit:
          A tuple with number of request per expiration time in seconds.

      Since providing an API is not our main focus, we keep the rate limit
      rather low (<10 requests per minute) while still allowing small crawl
      bursts by default.




   .. py:property:: rate_limit_cache
      :type: onegov.core.cache.RedisCacheRegion


      A cache for rate limits. 



.. py:function:: get_api_endpoints() -> list[str]