apitoolkit/apitoolkit-php

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:32:04 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许可证发布。