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

 composer require treblle/treblle-php

从Treblle仪表板获取您的 API密钥和项目ID 后，只需像这样在API代码中初始化Treblle

<?php

declare(strict_types=1);

use GuzzleHttp\Client;
use Treblle\Factory\TreblleFactory;

require_once __DIR__.'/../vendor/autoload.php';

error_reporting(E_ALL);
ob_start();

$treblle = TreblleFactory::create('_YOUR_API_KEY_', '_YOUR_PROJECT_ID_');

就这样。您的API请求和响应现在正在发送到您的Treblle项目。

查看此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做出贡献或创建一个SDK，请查看以下资源

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

社区 💙

首先，收藏和关注此存储库 以保持最新。

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

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

如何贡献

以下是一些使Treblle变得更好的贡献方式

试用Treblle，并告诉我们如何使Treblle对您更好。在Discord上告诉我们。
加入我们的Discord，与其他成员建立联系以分享和学习。
向我们的任何开源存储库发送pull请求。请查看您想贡献的存储库上的贡献指南以获取有关如何贡献的更多详细信息。我们期待您的贡献！

treblle / treblle-php

维护者

详细信息