# API: Log Http --- - [Introdução](#intro) - [Index](#index) - [List Configs](#list_configs) - [Set Configs](#set_configs) ## Introdução Esses endpoints são responsáveis por configurar e gerenciar os endpoints que receberão log no sistema via middleware App\Http\Middleware\HttpRequestLogMiddleware. ## Index Este endpoint retorna os logs registrados. ### Endpoint |Método|URI|Headers| |:|:-|:| |POST|`/http-logs`|Default| ### Body ```json Empty ``` ### Responses 200 - OK ```json [ { "id": , "http_method": , "path": , "payload": [], "response_body": {}, "created_at": , "user_id": }, //... ] ``` 403 - Forbidden ```json { "message": "User does not have the right roles.", } ``` 401 - Unauthorized ```json { "message": "Unauthenticated." } ``` ## List Configs Retorna uma lista de configurações de log, ou seja, uma lista dos endpoints do sistema, com um indicador booleano que especifica se o log está sendo registrado ou não. As configurações são armazenadas em um arquivo JSON físico localizado no diretório `storage/app/private/routes` no servidor. ### Endpoint |Método|URI|Headers| |:|:-|:| |GET|`/http-logs/configs`|Default| ### Body ```json Empty ``` ### Responses 200 - OK ```json [ { "path": , "isAuditing": , "description": , "http_method": }, //... ] ``` 403 - Forbidden ```json { "message": "User does not have the right roles.", } ``` 401 - Unauthorized ```json { "message": "Unauthenticated." } ``` ## Set Configs Endpoint usado para configurar os endpoints que receberão ou não logs. ### Endpoint |Método|URI|Headers| |:|:-|:| |GET|`/http-logs/configs`|Default| ### Body ```json Empty ``` ### Responses 200 - OK ```json [ { "path": , "isAuditing": , "description": , "http_method": }, //... ] ``` 403 - Forbidden ```json { "message": "User does not have the right roles.", } ``` 401 - Unauthorized ```json { "message": "Unauthenticated." } ```