apitoolkit/apitoolkit-laravel

APIToolkit 的 PHP/Laravel SDK 封装。它监控传入流量,收集请求并将请求发送到 apitoolkit 服务器。

v1.1.2 2024-06-19 19:23 UTC

This package is auto-updated.

Last update: 2024-09-10 09:30:51 UTC


README

APItoolkit's Logo APItoolkit's Logo

Laravel SDK

APItoolkit SDK Join Discord Server APItoolkit Docs

APItoolkit 是一个面向工程师和客户支持团队的端到端 API 和 Web 服务管理工具包。要将您的 Laravel (PHP) 应用程序与 APItoolkit 集成,您需要使用此 SDK 来监控传入流量,聚合请求,然后将其发送到 APItoolkit 服务器。

目录

安装

请运行以下命令安装 SDK

composer require apitoolkit/apitoolkit-laravel

配置

首先,将 APITOOLKIT_KEY 环境变量添加到您的 .env 文件中,如下所示

APITOOLKIT_KEY={ENTER_YOUR_API_KEY_HERE}

接下来,在 app/Http/Kernel.php 文件中的正确中间件组(例如,api)或根目录下注册中间件,如下所示

<?php

namespace App\Http;

use Illuminate\Foundation\Http\Kernel as HttpKernel;

class Kernel extends HttpKernel
{
    protected $middlewareGroups = [
        'api' => [
            // Other middleware here...
            \APIToolkit\Http\Middleware\APIToolkit::class, // Initialize the APItoolkit client
        ],
    ];
}

或者,如果您想监控特定的路由,可以注册中间件,如下所示

<?php

namespace App\Http;

use Illuminate\Foundation\Http\Kernel as HttpKernel;

class Kernel extends HttpKernel
{
    protected $routeMiddleware = [
        // Other middleware here...
        'apitoolkit' => \APIToolkit\Http\Middleware\APIToolkit::class,
    ];
}

然后您可以在路由中使用 apitoolkit 中间件,如下所示

Route::get('/', function () {
    return response()->json([
        'message' => 'Welcome to your new application!'
    ]);
})->middleware('apitoolkit');

注意

{ENTER_YOUR_API_KEY_HERE} 示例字符串替换为从 APItoolkit 控制台生成的 API 密钥


重要

要了解更多配置选项(编辑字段、错误报告、出站请求等),请阅读此 SDK 文档

贡献和帮助

要为此 SDK 的开发做出贡献或从社区和我们的团队请求帮助,请执行以下任何一项

许可证

此存储库根据 MIT 许可证发布。