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-symfony

通过将其添加到注册捆绑包列表中启用它，具体取决于您使用的 Symfony 版本。

// config/bundles.php
{
    return [
        // ...
        new Treblle\Symfony\TreblleBundle(),
    ];
}

通过将以下片段添加到您的项目配置中配置 SDK。如果您使用 Symfony 3.4，请将其添加到 app/config/config_prod.yml 中。对于 Symfony 4 或更高版本，请将值添加到 config/packages/treblle.yaml 中。

treblle:
  project_id: "%env(TREBLLE_PROJECT_ID)%"
  api_key: "%env(TREBLLE_API_KEY)%"
  debug: false
  masked:
    - password
    - api_key
    - secret
  endpoint_url: "https://rocknrolla.treblle.com" // optional

请参阅此 SDK 的文档以获取更多信息。

可用的 SDK

Treblle 提供了可让您无缝集成 Treblle 与您的基于 REST 的 API 的开源 SDK。

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，与其他成员联系以分享和学习。
向我们的任何开源存储库提交一个拉取请求。查看您想贡献的存储库的贡献指南，了解如何贡献的更多详细信息。我们期待您的贡献！

treblle / treblle-symfony

维护者

详细信息