Tool	Version
Framework
CLI

This is the repository for the API test framework, its CLI, it's documentation website and other related tooling.

The framework is the core of the project. It is built without a framework in Typescript and runs on Node.js.

This command line tool is free of frameworks and runs on Node.js. It serves as a tool to generate code for use with the framework.

The documentation website is a React application written in Typescript. It serves as the central web presence and documentation for all involved projects.

These are examples based on @idrinth/api-bench (the framework). Try them out to see how it works and what the framework provides.

The history microservice is a Fastify application, that serves as the central point of access to historical benchmark run data.

The history website is a svelte application, that serves as the central point of access to historical benchmark run data.

The dockerfiles provide runners/actions for continuous integration as well as the history website and microservice.

The brainstorming solution we use. It is based around markmap, a markdown to mindmap generator but consists of a lot of custom logic.

You can find the documentation on the Documentation Website. Additionally, we host the mindmap that assists the decision-making at the Mindmap Website.

Join our Slack if you need help, want to connect or have questions.

We have ready-to-be-used CI Images:

• Gitlab Runner
• Gitea Action
• Pure Alpine

We provide a monitoring solution out of the box.

• Microservice
• Website

To get your project ready for development you need to run the following commands in order:

• git clone https://github.com/idrinth/api-bench
• cd api-bench
• npm run setup

Further information about contributing is available in the contribution guidelines on the website and in the markdown file.

Commercial support and training is provided via Björn Büttner.

The @idrinth/api-bench framework and its CLI do not collect any kind of information about its users or the APIs being tested. All data is local to the device you run it on or the database server you configure it to dump data in.