AdonisJS SDK

APItoolkit is an end-to-end API and web services management toolkit for engineers and customer support teams. To integrate your AdonisJS application with APItoolkit, you need to use this SDK to monitor incoming traffic, aggregate the requests, and then deliver them to the APItoolkit's servers.

Table of Contents

• Installation
• Configuration
• Contributing and Help
• License

Installation

Kindly run the command below to install the SDK:

npm install apitoolkit-adonis@latest

Configuration

Next, run the command below to configure the SDK using ace:

node ace configure apitoolkit-adonis

Then, register the middleware by adding the apitoolkit-adonis client to your global middleware list in the start/kernel.js|ts file like so:

import server from "@adonisjs/core/services/server"
import APIToolkit from "apitoolkit-adonis"

const client = new APIToolkit();

server.use([
  () => import("#middleware/container_bindings_middleware"),
  () => import("#middleware/force_json_response_middleware"),
  () => import("@adonisjs/cors/cors_middleware"),
  () => client.middleware(),
])

Then, create an apitoolkit.js|ts file in the /conf directory and export the defineConfig object with some properties like so:

import { defineConfig } from 'apitoolkit-adonis'

export default defineConfig({
  apiKey: "{ENTER_YOUR_API_KEY_HERE}",
  debug: false,
  tags: ["environment: production", "region: us-east-1"],
  serviceVersion: "v2.0",
});

[!NOTE]

The {ENTER_YOUR_API_KEY_HERE} demo string should be replaced with the API key generated from the APItoolkit dashboard.

[!IMPORTANT]

To learn more configuration options (redacting fields, error reporting, outgoing requests, etc.), please read this SDK documentation.

Contributing and Help

To contribute to the development of this SDK or request help from the community and our team, kindly do any of the following:

• Read our Contributors Guide.
• Join our community Discord Server.
• Create a new issue in this repository.

License

This repository is published under the MIT license.