README

Treblle

集成 • 网站 • 文档 • 博客 • Twitter • Discord

Treblle是一个轻量级SDK，可以帮助工程和产品团队更快地构建、发布和维护基于REST的API。

特性

Treblle是如何工作的

一旦您将Treblle SDK集成到代码库中，此SDK就会将请求和响应数据发送到您的Treblle仪表板。

在您的Treblle仪表板中，您可以实时查看对API的请求、自动生成的API文档，以及API分析，例如端点的响应速度、响应负载大小等。

Treblle还使用发送到仪表板的请求来计算您的API评分，该评分是基于API的性能、质量和安全最佳实践的评分。

访问https://docs.treblle.com获取完整的文档。

安全性

字段遮罩

字段遮罩确保在数据发送到Treblle之前删除某些敏感数据。

为了确保在数据离开您的服务器之前完成遮罩，我们将其集成到所有SDK中。

这意味着数据遮罩非常快，并在发送API请求到Treblle之前在编程级别上发生。您可以在集成SDK时自定义要遮罩的确切字段。

访问字段遮罩部分的文档以获取完整的文档。

开始使用

登录到Treblle。
创建一个Treblle项目.
设置SDK以适应您的平台。

安装SDK

通过在终端中运行以下命令安装Laravel的Treblle

composer require treblle/treblle-laravel

您可以从Artisan控制台直接开始使用Treblle。只需在终端中键入以下命令

php artisan treblle:start

该命令引导您完成一个过程，并允许您创建账户、登录现有账户、创建新项目并获得您开始使用Treblle所需的所有.ENV密钥。

您还可以访问我们的网站https://app.treblle.com并创建一个免费账户以获取您的API密钥和项目ID。一旦您有了它们，只需将它们添加到您的.ENV文件中即可。

TREBLLE_API_KEY=YOUR_API_KEY
TREBLLE_PROJECT_ID=YOUR_PROJECT_ID

在您的API上启用Treblle

您第一步应该是在app/Http/Kernel.php中的中间件别名中注册Treblle。

protected $middlewareAliases = [
  // the rest of your middleware aliases
  'treblle' => \Treblle\Middlewares\TreblleMiddleware::class,
];

打开 routes/api.php 文件，并将 Treblle 中间件添加到如下所示的路线组中

Route::middleware(['treblle'])->group(function () {

  // YOUR API ROUTES GO HERE
  Route::prefix('samples')->group(function () {
    Route::get('{uuid}', [SampleController::class, 'view']);
    Route::post('store', [SampleController::class, 'store']);
  });

});

或者添加到单个路线中，如下所示

Route::group(function () {
  Route::prefix('users')->group(function () {

    // IS LOGGED BY TREBLLE
    Route::get('{uuid}', [UserController::class, 'view'])->middleware('treblle');

    // IS NOT LOGGED BY TREBLLE
    Route::post('{uuid}/update', [UserController::class, 'update']);
  });
});

设置完成。下次有人向您的 API 发送请求时，您将可以在 Treblle 控制面板中实时看到它，与其他功能一起，如：自动生成文档、错误跟踪、分析和 API 质量评分。

查看该 SDK 的文档以获取更多信息。

可用的 SDK

Treblle 提供了开源 SDK，让您能够无缝地将 Treblle 集成到基于 REST 的 API 中。

treblle-laravel：Laravel 的 SDK
treblle-php：PHP 的 SDK
treblle-symfony：Symfony 的 SDK
treblle-lumen：Lumen 的 SDK
treblle-sails：Sails 的 SDK
treblle-adonisjs：AdonisJS 的 SDK
treblle-fastify：Fastify 的 SDK
treblle-directus：Directus 的 SDK
treblle-strapi：Strapi 的 SDK
treblle-express：Express 的 SDK
treblle-koa：Koa 的 SDK
treblle-go：Go 的 SDK
treblle-ruby：Ruby on Rails 的 SDK
treblle-python：Python/Django 的 SDK

查看文档以获取更多关于 SDK 和集成的信息。

其他包

除了 SDK，我们还提供用于 SDK 开发的辅助工具和配置。如果您正在考虑贡献或创建 SDK，请查看以下资源

treblle-utils：一组对 JavaScript SDK 有用的辅助工具和实用函数。
php-utils：一组对 PHP SDK 有用的辅助工具和实用函数。

社区 💙

首先：请收藏并关注此仓库以保持最新。

此外，关注我们的博客和Twitter。

您可以在Discord上与团队和其他成员聊天，并在YouTube上查看我们的教程和其他视频资料。

如何贡献

以下是一些使 Treblle 更好的方式

尝试 Treblle，并告诉我们如何使 Treblle 对您更有用。在这里告诉我们Discord。
加入我们的Discord，与其他成员交流并从中学习。
向我们的任何开源仓库提交拉取请求。查看你想要贡献的仓库中的贡献指南，以获取更多关于如何贡献的详细信息。我们期待你的贡献！

treblle / treblle-laravel

维护者

详细信息