Skip to content
This repository was archived by the owner on Mar 25, 2025. It is now read-only.

Commit ed3f9c8

Browse files
committed
2 parents d825af9 + be114bf commit ed3f9c8

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

README.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
## AdonisJS SDK
77

88
[![APItoolkit SDK](https://img.shields.io/badge/APItoolkit-SDK-0068ff?logo=adonisjs)](https://github.com/topics/apitoolkit-sdk) [![](https://img.shields.io/npm/v/apitoolkit-adonis.svg?logo=npm)](https://npmjs.com/package/apitoolkit-adonis) [![](https://img.shields.io/npm/dw/apitoolkit-adonis
9-
)](https://npmjs.com/package/apitoolkit-adonis) [![Join Discord Server](https://img.shields.io/badge/Chat-Discord-7289da)](https://discord.gg/dEB6EjQnKB) [![APItoolkit Docs](https://img.shields.io/badge/Read-Docs-0068ff)](https://apitoolkit.io/docs/sdks/nodejs/adonisjs?utm_source=github-sdks)
9+
)](https://npmjs.com/package/apitoolkit-adonis) [![Join Discord Server](https://img.shields.io/badge/Chat-Discord-7289da)](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) [![APItoolkit Docs](https://img.shields.io/badge/Read-Docs-0068ff)](https://apitoolkit.io/docs/sdks/nodejs/adonisjs?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme)
1010

1111
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.
1212

@@ -39,11 +39,19 @@ Next, run the command below to configure the SDK using ace:
3939
node ace configure apitoolkit-adonis
4040
```
4141

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

4444
```js
45+
import server from "@adonisjs/core/services/server"
46+
import APIToolkit from "apitoolkit-adonis"
47+
48+
const client = new APIToolkit();
49+
4550
server.use([
46-
() => import('apitoolkit-adonis'),
51+
() => import("#middleware/container_bindings_middleware"),
52+
() => import("#middleware/force_json_response_middleware"),
53+
() => import("@adonisjs/cors/cors_middleware"),
54+
() => client.middleware(),
4755
])
4856
```
4957

@@ -54,25 +62,27 @@ import { defineConfig } from 'apitoolkit-adonis'
5462

5563
export default defineConfig({
5664
apiKey: "{ENTER_YOUR_API_KEY_HERE}",
57-
debug: false // Set to true to enable debug mode
58-
})
65+
debug: false,
66+
tags: ["environment: production", "region: us-east-1"],
67+
serviceVersion: "v2.0",
68+
});
5969
```
6070

6171
> [!NOTE]
6272
>
63-
> The `{ENTER_YOUR_API_KEY_HERE}` demo string should be replaced with the [API key](https://apitoolkit.io/docs/dashboard/settings-pages/api-keys?utm_source=github-sdks) generated from the APItoolkit dashboard.
73+
> The `{ENTER_YOUR_API_KEY_HERE}` demo string should be replaced with the [API key](https://apitoolkit.io/docs/dashboard/settings-pages/api-keys?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) generated from the APItoolkit dashboard.
6474
6575
<br />
6676

6777
> [!IMPORTANT]
6878
>
69-
> To learn more configuration options (redacting fields, error reporting, outgoing requests, etc.), please read this [SDK documentation](https://apitoolkit.io/docs/sdks/nodejs/adonisjs?utm_source=github-sdks).
79+
> To learn more configuration options (redacting fields, error reporting, outgoing requests, etc.), please read this [SDK documentation](https://apitoolkit.io/docs/sdks/nodejs/adonisjs?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme).
7080
7181
## Contributing and Help
7282

7383
To contribute to the development of this SDK or request help from the community and our team, kindly do any of the following:
7484
- Read our [Contributors Guide](https://github.com/apitoolkit/.github/blob/main/CONTRIBUTING.md).
75-
- Join our community [Discord Server](https://discord.gg/dEB6EjQnKB).
85+
- Join our community [Discord Server](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme).
7686
- Create a [new issue](https://github.com/apitoolkit/apitoolkit-adonis/issues/new/choose) in this repository.
7787

7888
## License
@@ -83,6 +93,6 @@ This repository is published under the [MIT](LICENSE) license.
8393

8494
<div align="center">
8595

86-
<a href="https://apitoolkit.io?utm_source=github-sdks" target="_blank" rel="noopener noreferrer"><img src="https://github.com/apitoolkit/.github/blob/main/images/icon.png?raw=true" width="40" /></a>
96+
<a href="https://apitoolkit.io?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme" target="_blank" rel="noopener noreferrer"><img src="https://github.com/apitoolkit/.github/blob/main/images/icon.png?raw=true" width="40" /></a>
8797

8898
</div>

0 commit comments

Comments
 (0)