⚠️ DEPRECATED PACKAGE

This SDK has been deprecated in favor of the new unified Treblle Node.js SDK v2.0

---

⚠️ DEPRECATED - Use New Treblle Node.js SDK v2.0

This package is deprecated and no longer maintained. Please migrate to the new unified Treblle Node.js SDK v2.0.

🚀 Migration to New SDK

The new Treblle Node.js SDK v2.0 provides better performance, more features, and unified support for all Node.js frameworks including Strapi.

Quick Migration

Old SDK:

// In config/middlewares.js
module.exports = [
  'plugin::treblle.treblle',
]

New SDK v2.0:

// middlewares/treblle/index.js
const { strapiTreblle } = require('treblle')

module.exports = (strapi) => {
  return {
    initialize() {
      strapi.app.use(strapiTreblle({
        sdkToken: "_YOUR_SDK_TOKEN_",
        apiKey: "_YOUR_API_KEY_"
      }))
    }
  }
}

// config/middlewares.js
module.exports = {
  settings: {
    treblle: {
      enabled: true,
    },
  },
}

Benefits of New SDK

• 🚀 40-60% faster API calls with optimized networking
• 🧠 50-70% reduction in memory usage
• ⚡ 80-90% faster field masking
• 🔧 Strapi 4.x & 5.x support
• 🛡️ Enhanced security with comprehensive field masking
• 📊 Better debugging and error handling
• 🎯 Smart admin route filtering

Installation

npm install treblle@^2.0.0

📖 Documentation

• New SDK Documentation
• npm Package

---

This repository will be archived soon. Please update your projects to use the new SDK.

Treblle

Integrations   •   Website   •   Docs   •   Blog   •   Twitter

---

API Intelligence Platform. 🚀

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

Features

• API Intelligance
• Auto-generated API Docs
• API analytics
• Treblle API Governance
• API Security
• API Testing
• API Assistant

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

1. Sign in to Treblle.
2. Create Workspace and your API.
3. Setup the SDK for your platform.

Install the SDK

npm i treblle --save

After installation set the following environment variables your .env

You can find the values in your Treblle dashboard

• TREBLLE_API_KEY
• TREBLLE_PROJECT_ID

treblle provides Strapi integration through middleware configuration.

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.

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.
• 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!

Contributors