-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #47 from Treblle/update-readme
Update README
- Loading branch information
Showing
1 changed file
with
117 additions
and
73 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,80 @@ | ||
| <img src="https://d224n10qh3hhwu.cloudfront.net/github/hero-laravel.jpg" alt="Treblle for Laravel" align="center"> | ||
| <div align="center"> | ||
| <img src="https://treblle-github.s3.amazonaws.com/header.png"/> | ||
| </div> | ||
| <div align="center"> | ||
|
|
||
| # Treblle for Laravel | ||
| # Treblle | ||
|
|
||
| [](https://packagist.org/packages/treblle/treblle-laravel) | ||
| [](https://php.net) | ||
| [](https://packagist.org/packages/treblle/treblle-laravel) | ||
| [](LICENSE.md) | ||
| <a href="https://docs.treblle.com/en/integrations" target="_blank">Integrations</a> | ||
| <span> • </span> | ||
| <a href="http://treblle.com/" target="_blank">Website</a> | ||
| <span> • </span> | ||
| <a href="https://docs.treblle.com" target="_blank">Docs</a> | ||
| <span> • </span> | ||
| <a href="https://blog.treblle.com" target="_blank">Blog</a> | ||
| <span> • </span> | ||
| <a href="https://twitter.com/treblleapi" target="_blank">Twitter</a> | ||
| <span> • </span> | ||
| <a href="https://treblle.com/chat" target="_blank">Discord</a> | ||
| <br /> | ||
|
|
||
| Treblle makes it super easy to understand what’s going on with your APIs and the apps that use them. Just by adding | ||
| Treblle to your API out of the box you get: | ||
| <hr /> | ||
| </div> | ||
|
|
||
| * Real-time API monitoring and logging | ||
| * Auto-generated API docs with OAS support | ||
| * API analytics | ||
| * Quality scoring | ||
| * One-click testing | ||
| * API management on the go | ||
| * Supports Laravel Vapor and Laravel Octane | ||
| * and more... | ||
| Treblle is a lightweight SDK that helps Engineering and Product teams build, ship & maintain REST based APIs faster. | ||
|
|
||
| ## Requirements | ||
| ## Features | ||
|
|
||
| * PHP 8.1+ | ||
| * Laravel 9+ | ||
| <div align="center"> | ||
| <br /> | ||
| <img src="https://treblle-github.s3.amazonaws.com/features.png"/> | ||
| <br /> | ||
| <br /> | ||
| </div> | ||
|
|
||
| ## Installation | ||
| - [API Monitoring & Observability](https://www.treblle.com/features/api-monitoring-observability) | ||
| - [Auto-generated API Docs](https://www.treblle.com/features/auto-generated-api-docs) | ||
| - [API analytics](https://www.treblle.com/features/api-analytics) | ||
| - [Treblle API Score](https://www.treblle.com/features/api-quality-score) | ||
| - [API Lifecycle Collaboration](https://www.treblle.com/features/api-lifecycle) | ||
| - [Native Treblle Apps](https://www.treblle.com/features/native-apps) | ||
|
|
||
| Install Treblle for Laravel via [Composer](http://getcomposer.org/) by running the following command in your terminal: | ||
|
|
||
| ```bash | ||
| ## 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](http://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](https://docs.treblle.com/en/security/masked-fields#fields-masked-by-default). | ||
|
|
||
| This means data masking is super fast and happens on a programming level before the API request is sent to Treblle. You can [customize](https://docs.treblle.com/en/security/masked-fields#custom-masked-fields) exactly which fields are masked when you’re integrating the SDK. | ||
|
|
||
| > Visit the [Masked fields](https://docs.treblle.com/en/security/masked-fields) section of the [docs](https://docs.sailscasts.com) for the complete documentation. | ||
|
|
||
| ## Get Started | ||
|
|
||
| 1. Sign in to [Treblle](https://app.treblle.com). | ||
| 2. [Create a Treblle project](https://docs.treblle.com/en/dashboard/projects#creating-a-project). | ||
| 3. [Setup the SDK](#install-the-SDK) for your platform. | ||
|
|
||
| ### Install the SDK | ||
|
|
||
| Install Treblle for Laravel via Composer by running the following command in your terminal: | ||
|
|
||
| ```sh | ||
| composer require treblle/treblle-laravel | ||
| ``` | ||
|
|
||
| ## Getting started | ||
|
|
||
| You can get started with Treblle **directly from your Artisan console**. Just type in the following command in your | ||
| terminal: | ||
|
|
||
|
|
@@ -42,17 +83,16 @@ php artisan treblle:start | |
| ``` | ||
|
|
||
| The command guides you through a process and allows you to create an account, login to your existing account, create a | ||
| new project and get all the .ENV keys you need to start using Treblle. | ||
| new project and get all the `.ENV` keys you need to start using Treblle. | ||
|
|
||
| You can also visit our website <https://treblle.com> and create a FREE account to get your API key and Project ID. Once | ||
| you have to simply add them to your .ENV file: | ||
| You can also visit our website [https://app.treblle.com](https://app.treblle.com) and create a FREE account to get your API key and Project ID. Once | ||
| you have them, simply add them to your `.ENV` file: | ||
|
|
||
| ```shell | ||
| TREBLLE_API_KEY=YOUR_API_KEY | ||
| TREBLLE_PROJECT_ID=YOUR_PROJECT_ID | ||
| ``` | ||
|
|
||
| ## Enabling Treblle on your API | ||
|
|
||
| Open the **routes/api.php** and add the Treblle middleware to either a route group like so: | ||
|
|
||
|
|
@@ -86,61 +126,65 @@ Route::group(function () { | |
| You're all set. Next time someone makes a request to your API you will see it in real-time on your Treblle dashboard | ||
| alongside other features like: auto-generated documentation, error tracking, analytics and API quality scoring. | ||
|
|
||
| ## Configuration options | ||
| > See the [docs](https://docs.treblle.com/en/integrations/laravel) for this SDK to learn more. | ||
| You can configure Treblle using just .ENV variables: | ||
| ## Available SDKs | ||
|
|
||
| ```shell | ||
| TREBLLE_IGNORED_ENV=local,dev,test | ||
| ``` | ||
| Treblle provides [open-source SDKs](https://docs.treblle.com/en/integrations) that let you seamlessly integrate Treblle with your REST-based APIs. | ||
|
|
||
| Define which environments Treblle should NOT LOG at all. By default, Treblle will log all environments except local, dev | ||
| and test. If you want to change that you can define your own ignored environments by using a comma separated list, or | ||
| allow all environments by leaving the value empty. | ||
| - [`treblle-laravel`](https://github.com/Treblle/treblle-laravel): SDK for Laravel | ||
| - [`treblle-php`](https://github.com/Treblle/treblle-php): SDK for PHP | ||
| - [`treblle-symfony`](https://github.com/Treblle/treblle-symfony): SDK for Symfony | ||
| - [`treblle-lumen`](https://github.com/Treblle/treblle-lumen): SDK for Lumen | ||
| - [`treblle-sails`](https://github.com/Treblle/treblle-sails): SDK for Sails | ||
| - [`treblle-adonisjs`](https://github.com/Treblle/treblle-adonisjs): SDK for AdonisJS | ||
| - [`treblle-fastify`](https://github.com/Treblle/treblle-fastify): SDK for Fastify | ||
| - [`treblle-directus`](https://github.com/Treblle/treblle-directus): SDK for Directus | ||
| - [`treblle-strapi`](https://github.com/Treblle/treblle-strapi): SDK for Strapi | ||
| - [`treblle-express`](https://github.com/Treblle/treblle-express): SDK for Express | ||
| - [`treblle-koa`](https://github.com/Treblle/treblle-koa): SDK for Koa | ||
| - [`treblle-go`](https://github.com/Treblle/treblle-go): SDK for Go | ||
| - [`treblle-ruby`](https://github.com/Treblle/treblle-ruby): SDK for Ruby on Rails | ||
| - [`treblle-python`](https://github.com/Treblle/treblle-python): SDK for Python/Django | ||
|
|
||
| ### Masked fields | ||
| > See the [docs](https://docs.treblle.com/en/integrations) for more on SDKs and Integrations. | ||
| Treblle **masks sensitive information** from both the request and response data as well as the request headers data | ||
| **before it even leaves your server**. The following parameters are automatically masked: password, pwd, secret, | ||
| password_confirmation, cc, card_number, ccv, ssn, credit_score. | ||
| ## Other Packages | ||
|
|
||
| You can customize this list by editing your configuration file. If you did not published your configuration file, run | ||
| this command first: | ||
| 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: | ||
|
|
||
| ```bash | ||
| php artisan vendor:publish --tag=treblle-config | ||
| ``` | ||
| - [`treblle-utils`](https://github.com/Treblle/treblle-utils): A set of helpers and | ||
| utility functions useful for the JavaScript SDKs. | ||
| - [`php-utils`](https://github.com/Treblle/php-utils): A set of helpers and | ||
| utility functions useful for the PHP SDKs. | ||
|
|
||
| This will create a file at "config/treblle.php". Then, open this file and tweak the masked fields: | ||
| ## Community 💙 | ||
|
|
||
| ```php | ||
| return [ | ||
| // ... | ||
|
|
||
| /* | ||
| * Define which fields should be masked before leaving the server | ||
| */ | ||
| 'masked_fields' => [ | ||
| 'password', | ||
| 'pwd', | ||
| 'secret', | ||
| 'password_confirmation', | ||
| 'cc', | ||
| 'card_number', | ||
| 'ccv', | ||
| 'ssn', | ||
| 'credit_score', | ||
| 'api_key', | ||
| ], | ||
| ]; | ||
| ``` | ||
| First and foremost: **Star and watch this repository** to stay up-to-date. | ||
|
|
||
| Also, follow our [Blog](https://blog.treblle.com), and on [Twitter](https://twitter.com/treblleapi). | ||
|
|
||
| You can chat with the team and other members on [Discord](https://treblle.com/chat) and follow our tutorials and other video material at [YouTube](https://youtube.com/@treblle). | ||
|
|
||
| [](https://treblle.com/chat) | ||
|
|
||
| [](https://youtube.com/@treblle) | ||
|
|
||
| [](https://twitter.com/treblleapi) | ||
|
|
||
| ## Support | ||
| ### How to contribute | ||
|
|
||
| If you have problems of any kind feel free to reach out via <https://treblle.com> or email [email protected], and we'll | ||
| do our best to help you out. | ||
| Here are some ways of contributing to making Treblle better: | ||
|
|
||
| ## License | ||
| - **[Try out Treblle](https://docs.treblle.com/en/introduction#getting-started)**, and let us know ways to make Treblle better for you. Let us know here on [Discord](https://treblle.com/chat). | ||
| - Join our [Discord](https://treblle.com/chat) and connect with other members to share and learn from. | ||
| - Send a pull request to any of our [open source repositories](https://github.com/Treblle) 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! | ||
|
|
||
| Copyright 2022., Treblle Limited. Licensed under the MIT license: | ||
| http://www.opensource.org/licenses/mit-license.php | ||
| ### Contributors | ||
| <a href="https://github.com/Treblle/treblle-laravel/graphs/contributors"> | ||
| <p align="center"> | ||
| <img src="https://contrib.rocks/image?repo=Treblle/treblle-laravel" alt="A table of avatars from the project's contributors" /> | ||
| </p> | ||
| </a> | ||