Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apitoolkit/apitoolkit-adonis
APItoolkit's Adonis client SDK.
https://github.com/apitoolkit/apitoolkit-adonis
adonisjs apitoolkit apitoolkit-sdk javascript nodejs typescript
Last synced: about 17 hours ago
JSON representation
APItoolkit's Adonis client SDK.
- Host: GitHub
- URL: https://github.com/apitoolkit/apitoolkit-adonis
- Owner: apitoolkit
- License: mit
- Created: 2023-12-09T21:32:48.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-05-22T20:00:12.000Z (6 months ago)
- Last Synced: 2024-05-22T21:24:27.633Z (6 months ago)
- Topics: adonisjs, apitoolkit, apitoolkit-sdk, javascript, nodejs, typescript
- Language: TypeScript
- Homepage:
- Size: 734 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## AdonisJS SDK
[](https://github.com/topics/apitoolkit-sdk) [](https://npmjs.com/package/apitoolkit-adonis) [](https://npmjs.com/package/apitoolkit-adonis) [](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) [](https://apitoolkit.io/docs/sdks/nodejs/adonisjs?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme)
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](#installation)
- [Configuration](#configuration)
- [Contributing and Help](#contributing-and-help)
- [License](#license)
---
## Installation
Kindly run the command below to install the SDK:
```sh
npm install apitoolkit-adonis@latest
```
## Configuration
Next, run the command below to configure the SDK using ace:
```sh
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:
```js
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:
```js
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](https://apitoolkit.io/docs/dashboard/settings-pages/api-keys?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) generated from the APItoolkit dashboard.
> [!IMPORTANT]
>
> 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).
## 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](https://github.com/apitoolkit/.github/blob/main/CONTRIBUTING.md).
- Join our community [Discord Server](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme).
- Create a [new issue](https://github.com/apitoolkit/apitoolkit-adonis/issues/new/choose) in this repository.
## License
This repository is published under the [MIT](LICENSE) license.
---
