escolalms/tracker

Escola 无头 LMS 追踪器

0.1.0 2024-02-14 13:40 UTC

This package is auto-updated.

Last update: 2024-09-14 14:51:50 UTC


README

swagger codecov phpunit downloads downloads downloads

它做什么

此包用于跟踪 API 路由。默认情况下启用追踪器,并跟踪以 /api/admin 前缀开头的路由。默认情况下,/api/admin/tracks/routes 被忽略。

安装

  • composer require escolalms/tracker
  • php artisan migrate
  • php artisan db:seed --class="EscolaLms\Tracker\Database\Seeders\TrackerPermissionSeeder"

配置

您可以通过在 .env 文件中指定键来配置此包。

  • TRACKER_ENABLED - 启用或禁用路由追踪
  • TRACKER_ROUTE_PREFIX - 设置追踪的路由前缀
  • TRACKER_CONNECTION - 数据库连接,默认为 sqlite

您还可以使用 门面 来配置追踪器。

Tracker::disable();
Http::get('api/admin/example-route')
Tracker::enable();

... 

Tracker::ignoreUris(['api/admin/example-route']);
Http::get('api/admin/example-route')

... 

Tracker::prefix('api');
Http::get('api/example-route')

数据库

TrackRoutes - stores tracked routes

track_routes 示例行

端点

swagger

测试

运行 ./vendor/bin/phpunit 以运行测试。请参阅 测试 文件夹,它作为文档附录是一个很好的起点。

codecov phpunit

权限

权限在 种子器 中定义

问题

  • 没有权限写入数据库

    如果您遇到此类错误,您需要检查服务器上 database.sqlite 文件的权限。如果文件没有写权限,SQL 将抛出一个无法写入的错误。该文件应至少有 0666 权限。

  • 找不到 track_routes 表

    此错误发生是因为创建表的迁移尚未运行。只有一个空的数据库文件。您应运行 php artisan oprimize:clearphp artisan cache:clear 命令。SqliteServiceProvider 将检查缓存中的值以确定迁移是否已运行,如果表不存在,它将在数据库中创建它。