Stradex / api-bench

a typescript benchmark library meant for all apis

Home Page:https://idrinth-api-ben.ch/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

@idrinth/api-bench

Coverage Status Codacy Badge

Contents

What does this project do?

This project provides a framework for testing rest-apis and websites for changes in response times. This helps to detect performance changes in code in a quick and simple manner.

Why use a Benchmark Runner

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.

Regarding existing libraries

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 minimize the effect of complicated validations or huge response bodies on the data gathering.

Usage & Examples

Please have a look at the website for more information.

License

As usual with my projects this is MIT-licensed.

Support

Additionally, to support requests via issue, you can reach me via discord at Idrinth's Discord. Commercial support and training is provided via Björn Büttner.

About

a typescript benchmark library meant for all apis

https://idrinth-api-ben.ch/

License:MIT License


Languages

Language:TypeScript 95.1%Language:CSS 2.0%Language:JavaScript 1.8%Language:HTML 1.1%