yxs/apilogger

用于查看API日志的轻量级Laravel包,可用于调试。

dev-master 2024-03-19 05:58 UTC

This package is auto-updated.

Last update: 2024-09-19 07:20:03 UTC


README

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

安装

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

使用

  1. Laravel 5.5及更高版本使用包自动发现,因此不需要您手动添加ServiceProvider。如果您使用的是Laravel的较低版本,则必须在您的app.php文件中注册它
YXS\Providers\ApiLogServiceProvider::class
  1. 使用以下命令发布配置文件
php artisan vendor:publish --tag=config --provider="YXS\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)。有关更多信息,请参阅许可证文件