{"id":18696198,"url":"https://github.com/apitoolkit/apitoolkit-adonis","last_synced_at":"2025-03-20T11:20:03.163Z","repository":{"id":211976002,"uuid":"729638909","full_name":"apitoolkit/apitoolkit-adonis","owner":"apitoolkit","description":"APItoolkit's Adonis client SDK.","archived":false,"fork":false,"pushed_at":"2024-05-22T20:00:12.000Z","size":752,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-05-22T21:24:27.633Z","etag":null,"topics":["adonisjs","apitoolkit","apitoolkit-sdk","javascript","nodejs","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apitoolkit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-09T21:32:48.000Z","updated_at":"2024-08-04T09:00:13.598Z","dependencies_parsed_at":"2023-12-11T23:10:19.932Z","dependency_job_id":"85e6c499-f9e7-4eeb-a0f8-c742a6f994f3","html_url":"https://github.com/apitoolkit/apitoolkit-adonis","commit_stats":null,"previous_names":["apitoolkit/apitoolkit-adonis"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apitoolkit%2Fapitoolkit-adonis","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apitoolkit%2Fapitoolkit-adonis/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apitoolkit%2Fapitoolkit-adonis/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apitoolkit%2Fapitoolkit-adonis/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apitoolkit","download_url":"https://codeload.github.com/apitoolkit/apitoolkit-adonis/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244600725,"owners_count":20479307,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["adonisjs","apitoolkit","apitoolkit-sdk","javascript","nodejs","typescript"],"created_at":"2024-11-07T11:17:29.637Z","updated_at":"2025-03-20T11:20:03.139Z","avatar_url":"https://github.com/apitoolkit.png","language":"TypeScript","readme":"\u003cdiv align=\"center\"\u003e\n\n![APItoolkit's Logo](https://github.com/apitoolkit/.github/blob/main/images/logo-white.svg?raw=true#gh-dark-mode-only)\n![APItoolkit's Logo](https://github.com/apitoolkit/.github/blob/main/images/logo-black.svg?raw=true#gh-light-mode-only)\n\n## AdonisJS SDK\n\n[![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\n)](https://npmjs.com/package/apitoolkit-adonis) [![Join Discord Server](https://img.shields.io/badge/Chat-Discord-7289da)](https://apitoolkit.io/discord?utm_campaign=devrel\u0026utm_medium=github\u0026utm_source=sdks_readme) [![APItoolkit Docs](https://img.shields.io/badge/Read-Docs-0068ff)](https://apitoolkit.io/docs/sdks/nodejs/adonisjs?utm_campaign=devrel\u0026utm_medium=github\u0026utm_source=sdks_readme) \n\nAPItoolkit 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.\n\n\u003c/div\u003e\n\n---\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Configuration](#configuration)\n- [Contributing and Help](#contributing-and-help)\n- [License](#license)\n\n---\n\n## Installation\n\nKindly run the command below to install the SDK:\n\n```sh\nnpm install apitoolkit-adonis@latest\n```\n\n## Configuration\n\nNext, run the command below to configure the SDK using ace:\n\n```sh\nnode ace configure apitoolkit-adonis\n```\n\nThen, register the middleware by adding the `apitoolkit-adonis` client to your global middleware list in the `start/kernel.js|ts` file like so:\n\n```js\nimport server from \"@adonisjs/core/services/server\"\nimport APIToolkit from \"apitoolkit-adonis\"\n\nconst client = new APIToolkit();\n\nserver.use([\n  () =\u003e import(\"#middleware/container_bindings_middleware\"),\n  () =\u003e import(\"#middleware/force_json_response_middleware\"),\n  () =\u003e import(\"@adonisjs/cors/cors_middleware\"),\n  () =\u003e client.middleware(),\n])\n```\n\nThen, create an `apitoolkit.js|ts` file in the `/conf` directory and export the `defineConfig` object with some properties like so:\n\n```js\nimport { defineConfig } from 'apitoolkit-adonis'\n\nexport default defineConfig({\n  apiKey: \"{ENTER_YOUR_API_KEY_HERE}\",\n  debug: false,\n  tags: [\"environment: production\", \"region: us-east-1\"],\n  serviceVersion: \"v2.0\",\n});\n```\n\n\u003e [!NOTE]\n\u003e \n\u003e 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\u0026utm_medium=github\u0026utm_source=sdks_readme) generated from the APItoolkit dashboard.\n\n\u003cbr /\u003e\n\n\u003e [!IMPORTANT]\n\u003e \n\u003e 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\u0026utm_medium=github\u0026utm_source=sdks_readme).\n\n## Contributing and Help\n\nTo contribute to the development of this SDK or request help from the community and our team, kindly do any of the following:\n- Read our [Contributors Guide](https://github.com/apitoolkit/.github/blob/main/CONTRIBUTING.md).\n- Join our community [Discord Server](https://apitoolkit.io/discord?utm_campaign=devrel\u0026utm_medium=github\u0026utm_source=sdks_readme).\n- Create a [new issue](https://github.com/apitoolkit/apitoolkit-adonis/issues/new/choose) in this repository.\n\n## License\n\nThis repository is published under the [MIT](LICENSE) license.\n\n---\n\n\u003cdiv align=\"center\"\u003e\n    \n\u003ca href=\"https://apitoolkit.io?utm_campaign=devrel\u0026utm_medium=github\u0026utm_source=sdks_readme\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\u003cimg src=\"https://github.com/apitoolkit/.github/blob/main/images/icon.png?raw=true\" width=\"40\" /\u003e\u003c/a\u003e\n\n\u003c/div\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapitoolkit%2Fapitoolkit-adonis","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapitoolkit%2Fapitoolkit-adonis","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapitoolkit%2Fapitoolkit-adonis/lists"}