typeable/compaREST
1
0
Fork 0
mirror of https://github.com/typeable/compaREST.git synced 2024-12-25 04:05:05 +03:00
Code Issues Projects Releases Wiki Activity
master
compaREST/benchmarks
History
mniip f4fd16d247
Naming changes (#117) 
* Rename openapi-diff -> comparest

Rename OpenAPI.Checker -> Data.OpenApi.Compare

* Tweak emojis used in reports

* Shuffle imports

* Fix workflow

* Reuse nix

Co-authored-by: iko <ilyakooo0@gmail.com>
2021-08-16 13:41:22 +03:00
..
atlassian Added tool comparison benchmarks scaffolding (#103) 2021-07-12 18:44:30 +03:00
nix Added tool comparison benchmarks scaffolding (#103) 2021-07-12 18:44:30 +03:00
oasdiff Added tool comparison benchmarks scaffolding (#103) 2021-07-12 18:44:30 +03:00
openapitools Added tool comparison benchmarks scaffolding (#103) 2021-07-12 18:44:30 +03:00
default.nix Naming changes (#117) 2021-08-16 13:41:22 +03:00
README.md Naming changes (#117) 2021-08-16 13:41:22 +03:00
report.md Added preliminary report example (#105) 2021-07-15 09:30:01 +03:00

README.md

OpenApi comparison benchmarks

This is a nix expression that automatically downloads, builds and runs multiple OpenAPI comparison tools on the same set of inputs to compare how well they behave.

To run the benchmarks run the following command in this directory:

nix-build

The tools

Tool Output file name
Typeable CompaREST typeable.md
Atlassian OpenApi Diff atlassian.json, atlassian.error.txt
OpenApi Tools OpenApi Diff openapitools.md, openapitools.error.txt
Tufin OpenApi Diff oasdiff.txt, oasdiff.error.txt
Bump bump.txt

Running with Bump.sh

Bump.sh is a closed-source tool that is only available via REST API. To include bump.sh in the benchmark results you have to supply your credentials as arguments:

nix-build --argstr bumpToken <TOKEN> --argstr bumpDocumentation <DOCUMENTATION IDENTIFIER>