magpie.api.swagger
==================

.. py:module:: magpie.api.swagger


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/magpie/api/swagger/views/index


Attributes
----------

.. autoapisummary::

   magpie.api.swagger.LOGGER


Functions
---------

.. autoapisummary::

   magpie.api.swagger.api_schema
   magpie.api.swagger.api_swagger
   magpie.api.swagger.get_logger
   magpie.api.swagger.includeme


Package Contents
----------------

.. py:function:: api_schema(request: pyramid.request.Request) -> magpie.typedefs.JSON

   Return JSON Swagger specifications of Magpie REST API.


.. py:function:: api_swagger(request)

   Swagger UI route to display the Magpie REST API schemas.


.. py:function:: get_logger(name: magpie.typedefs.Str, level: Optional[int] = None, force_stdout: bool = None, message_format: Optional[magpie.typedefs.Str] = None, datetime_format: Optional[magpie.typedefs.Str] = None) -> logging.Logger

   Immediately sets the logger level to avoid duplicate log outputs from the `root logger` and `this logger` when
   `level` is ``logging.NOTSET``.


.. py:data:: LOGGER

.. py:function:: includeme(config)