awt/apilogger

一个用于查看API日志的小型Laravel包,可用于调试。

dev-master 2022-10-02 08:13 UTC

This package is not auto-updated.

Last update: 2024-09-18 05:22:28 UTC


README

这是一个小包,可以帮助调试API日志。它可以记录请求方法、URL、持续时间、请求数据、获取的模型、控制器和方法。

screenshot

安装

  1. 通过composer安装此包
composer require awt/apilogger @dev

使用

  1. Laravel 5.5及以上版本使用包自动发现,因此无需手动添加ServiceProvider。如果你使用的是Laravel的更低版本,你必须在你的app.php文件中注册它
AWT\Providers\ApiLogServiceProvider::class
  1. 使用以下命令发布配置文件
php artisan vendor:publish --tag=config --provider="AWT\Providers\ApiLogServiceProvider"

配置文件名为apilogs.php。当前支持的驱动程序是dbfile

默认情况下,记录器将使用file来记录数据。但如果你想使用数据库进行记录,可以通过以下命令迁移表

你也可以配置哪些字段不应该被记录,如密码、机密等。

如果你只是使用文件驱动,你不需要迁移

php artisan migrate
  1. 将名为apilogger的中间件添加到你想记录数据的路由或控制器
//in route.php or web.php
Route::middleware('apilogger')->post('/test',function(){
    return response()->json("test");
});
  1. 仪表板可以通过yourdomain.com/apilogs访问

清除日志

你可以使用以下命令永久清除日志。

php artisan apilog:clear

实现自己的日志驱动

  1. 你的驱动类必须实现ApiLoggerInterface接口以保存、检索和删除日志。
  2. 你的驱动类可能继承自AbstractLogger类,它提供了诸如logData和mapArrayToModel等有用的方法。
  3. 在新的类名中替换dbfile作为驱动程序。例如:\App\Apilogs\CustomLogger::class

安全

添加认证

在config/apilog.php中,你有'route'选项,你可以更改前缀并添加认证中间件或任何其他中间件

'route'          => [
    'prefix'     => 'apilogs',
    'middleware' => null,//Can be change to ['auth'] or others
]

如果你发现任何安全相关的问题,请通过agwinthant@gmail.com发送电子邮件,而不是使用问题跟踪器。

许可

MIT许可(MIT)。有关更多信息,请参阅许可文件