apifrom.plugins.logging
=======================


Logging plugin for APIFromAnything.

This module provides a plugin for logging requests and responses.



.. py:currentmodule:: apifrom.plugins.logging

Overview
--------

**Classes**

* :py:class:`API`
* :py:class:`LoggingPlugin`
* :py:class:`Plugin`
* :py:class:`Request`
* :py:class:`Response`






Classes
-------

.. py:class:: API(debug = False, title = 'APIFromAnything API', description = 'API created with APIFromAnything', version = '1.0.0', docs_url = '/docs', openapi_config = None, swagger_ui_config = None, enable_docs = True)

Main application container for APIFromAnything.

   This class serves as the central registry for all API endpoints, middleware,
   and configuration. It provides methods for registering endpoints, middleware,
   and starting the server.

   .. attribute:: router

      The router instance for managing routes.

      :type: Router

   .. attribute:: middleware

      List of middleware instances.

      :type: list

   .. attribute:: debug

      Whether to run in debug mode.

      :type: bool

   .. attribute:: title

      The title of the API.

      :type: str

   .. attribute:: description

      The description of the API.

      :type: str

   .. attribute:: version

      The version of the API.

      :type: str

   .. attribute:: docs_url

      The URL for the API documentation.

      :type: str

   Initialize a new API instance.

   :param debug: Whether to run in debug mode.
   :param title: The title of the API.
   :param description: The description of the API.
   :param version: The version of the API.
   :param docs_url: The URL for the API documentation.
   :param openapi_config: Configuration for OpenAPI documentation.
   :param swagger_ui_config: Configuration for Swagger UI.
   :param enable_docs: Whether to enable API documentation.
















































.. py:class:: LoggingPlugin(logger = None, level = logging.INFO, log_request_body = False, log_response_body = False, log_headers = False, exclude_paths = None, exclude_methods = None):bases: apifrom.plugins.base.Plugin


Plugin for logging requests and responses.

   Initialize the logging plugin.

   :param logger: The logger to use (defaults to a new logger)
   :param level: The logging level
   :param log_request_body: Whether to log request bodies
   :param log_response_body: Whether to log response bodies
   :param log_headers: Whether to log headers
   :param exclude_paths: Paths to exclude from logging
   :param exclude_methods: HTTP methods to exclude from logging












.. :: _name






.. :: exclude_methods




.. :: exclude_paths




.. :: level




.. :: log_headers




.. :: log_request_body




.. :: log_response_body




.. :: logger


   Get the logger for this plugin.

      :returns: The plugin logger















.. method:: initialize(api)

   Initialize the plugin.

      :param api: The API instance



.. method:: on_error(error, request)

   Log an error.

      :param error: The error that occurred
      :param request: The request object

      :returns: None





.. method:: on_shutdown()

   Log server shutdown.



.. method:: on_startup()

   Log server startup.



.. method:: post_response(response, request)

   Log the response.

      :param response: The response object
      :param request: The request object

      :returns: The response object



.. method:: pre_request(request)

   Log the request.

      :param request: The request object

      :returns: The request object










.. py:class:: Plugin:bases: abc.ABC


Base class for all plugins.

   This class defines the interface that all plugins must implement, providing
   hooks for various stages of the API lifecycle.

   Initialize the plugin.












































.. py:class:: Request(request = None, path_params = None, method = None, path = None, query_params = None, headers = None, body = None, client_ip = None)

Request class for APIFromAnything.

   This class wraps a Starlette request and provides methods for accessing
   request data in a convenient way.

   .. attribute:: _request

      The underlying Starlette request.

   .. attribute:: path_params

      Path parameters extracted from the URL.

   .. attribute:: query_params

      Query parameters extracted from the URL.

   .. attribute:: headers

      HTTP headers.

   .. attribute:: method

      HTTP method.

   .. attribute:: path

      Request path.

   .. attribute:: _body

      Cached request body.

   Initialize a new Request instance.

   :param request: The underlying Starlette request.
   :param path_params: Path parameters extracted from the URL.
   :param method: The HTTP method.
   :param path: The request path.
   :param query_params: Query parameters.
   :param headers: HTTP headers.
   :param body: Request body.
   :param client_ip: Client IP address.


















.. py:class:: Response(content = None, status_code = 200, headers = None, content_type = 'application/json')

Response class for APIFromAnything.

   This class represents an HTTP response and provides methods for setting
   response data, status code, and headers.

   .. attribute:: content

      The response content.

   .. attribute:: status_code

      The HTTP status code.

   .. attribute:: headers

      HTTP headers.

   .. attribute:: content_type

      The content type of the response.

   Initialize a new Response instance.

   :param content: The response content.
   :param status_code: The HTTP status code.
   :param headers: HTTP headers.
   :param content_type: The content type of the response.