README

Treblle

Integrations • Website • Docs • Blog • Twitter • Discord

Treblle is a lightweight SDK that helps Engineering and Product teams build, ship & maintain REST based APIs faster.

Features

How Treblle Works

Once you’ve integrated a Treblle SDK in your codebase, this SDK will send requests and response data to your Treblle Dashboard.

In your Treblle Dashboard you get to see real-time requests to your API, auto-generated API docs, API analytics like how fast the response was for an endpoint, the load size of the response, etc.

Treblle also uses the requests sent to your Dashboard to calculate your API score which is a quality score that’s calculated based on the performance, quality, and security best practices for your API.

Visit https://docs.treblle.com for the complete documentation.

Security

Masking fields

Masking fields ensure certain sensitive data are removed before being sent to Treblle.

To make sure masking is done before any data leaves your server we built it into all our SDKs.

This means data masking is super fast and happens on a programming level before the API request is sent to Treblle. You can customize exactly which fields are masked when you’re integrating the SDK.

Visit the Masked fields section of the docs for the complete documentation.

Get Started

Sign in to Treblle.
Create a Treblle project.
Setup the SDK for your platform.

Install the SDK

composer require treblle/treblle-lumen

Getting started

Installing Lumen packages is a lot more complicated than Laravel packages and requires a few manual steps. If you want a completely automated process please use Laravel.

Step 1: Publish config files

The first thing we need to do is publish the Treblle config file and make sure Lumen loads it. To do that we need to copy/paste the package config file like so:

mkdir -p config
cp vendor/treblle/treblle-lumen/config/treblle.php config/treblle.php

Now we can have Lumen load the config file. We do that by adding a new line in bootstrap/app.php, under the Register Config Files section, like so:

$app->configure('treblle');

We need to register the Treblle middleware in Lumen. To do add a new line of code to bootstrap/app.php, under the Register Middleware section, like so:

$app->routeMiddleware([
    'treblle' => Treblle\Middlewares\TreblleMiddleware::class
]);

You need an API key and Project ID for Treblle to work. You can get those by creating a FREE account on treblle.com and your first project. You'll get the two keys which you need to add to your .ENV file like so:

TREBLLE_API_KEY=YOUR_API_KEY
TREBLLE_PROJECT_ID=YOUR_PROJECT_ID

Enable Treblle on your API

Now that we've installed the package we simply need to enable it. Open routes/web.php and assign the treblle middleware to your API routes like so:

$router->group(['prefix' => 'api', 'middleware' => 'treblle'], function () use ($router) {
    $router->get('users',  ['uses' => 'UserController@index']);
    $router->post('users',  ['uses' => 'TestController@store']);
});

You're all set. Next time someone makes a request to your API you will see it in real-time on your Treblle dashboard.

See the docs for this SDK to learn more.

Available SDKs

Treblle provides open-source SDKs that let you seamlessly integrate Treblle with your REST-based APIs.

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

See the docs for more on SDKs and Integrations.

Other Packages

Besides the SDKs, we also provide helpers and configuration used for SDK development. If you're thinking about contributing to or creating a SDK, have a look at the resources below:

treblle-utils: A set of helpers and utility functions useful for the JavaScript SDKs.
php-utils: A set of helpers and utility functions useful for the PHP SDKs.

Community 💙

First and foremost: Star and watch this repository to stay up-to-date.

Also, follow our Blog, and on Twitter.

You can chat with the team and other members on Discord and follow our tutorials and other video material at YouTube.

How to contribute

Here are some ways of contributing to making Treblle better:

Try out Treblle, and let us know ways to make Treblle better for you. Let us know here on Discord.
Join our Discord and connect with other members to share and learn from.
Send a pull request to any of our open source repositories on Github. Check the contribution guide on the repo you want to contribute to for more details about how to contribute. We're looking forward to your contribution!

treblle / treblle-lumen

Maintainers

Details