A library to benchmark apis, no matter if rest or soap
npm install @idrinth/api-bench
- Contents
- What does this Project do?
- Why a Benchmark Runner
- Regarding existing libraries
- Usage & Examples
- CI-Images
- Monitoring
- License
- Support
This project provides a framework for testing restful APIs and websites for
changes in response times. This helps to detect performance changes in code
in a quick and simple manner.
Given, that the amount of APIs increase by moving to microservices, we need a
way to determine if changes to a service's response times are related to code
changes. For this purpose a defined load with repeatable request seems the
most useful.
Other tools like
matteofigus/api-benchmark,
bvanderlaan/api-bench-runner
or jeffbski/bench-rest are all
untouched for quite a while and don't provide type definitions for typescript.
This makes them less desirable when working with bigger projects where the
better static codecheck is a huge boost in development speed.
Additionally, this tool separates the validation thread from the thread
processing the actual requests to further minimise the effect of complicated
validations or huge response bodies on the data gathering.
Please have a look at the website for more
information.
We have ready to be used CI Images:
- Gitlab Runner
- Gitea Action
- Pure Alpine
We provide a monitoring solution out of the box.
As usual with my projects this is MIT-licensed.
Additionally, to support requests via issue, you can reach us via
Slack.
Commercial support and training is provided via
Björn Büttner.