README.md

@idrinth/api-bench

Tool	Version
Framework
CLI

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

Project parts

• Framework README
• CLI README
• Documentation Website README
• Examples
• History Microservice README
• Dockerfiles
• Mindmap

Documentation

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

Slack

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

CI Images

We have ready to be used CI Images:

• Gitlab Runner
• Gitea Action
• Pure Alpine

Monitoring

We provide a monitoring solution out of the box.

• Microservice
• Website

Setup

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.

Support

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

Privacy and Compliance

The @idrinth/api-bench framework does 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.