serdartaylan/apilogger

awt/apilogger, jadayash/apilogger 的分支

v0.0.1 2022-01-19 06:40 UTC

This package is not auto-updated.

Last update: 2024-09-26 18:24:11 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

安全

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

许可证

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