thomaspoignant/api-scenario repository overview

⁠API-scenario

API-scenario is a simple command line tool that allow you to execute easily a scenario to test your APIs.

It is perfect to make end to end tests, you could use in your CI workflow to validate your deployment or just to test locally your development.

⁠Getting Started

docker pull api-scenario:latest

⁠Run container

⁠Version

To get the version of the command line please run:

docker run thomaspoignant/api-scenario:latest version

⁠Run a scenario

To run a scenario you can use this command:

docker run -v ~/:/scenario thomaspoignant/api-scenario:latest run --scenario scenario.yml

As you can see we use the option -v to map our local folder to the scenario folder inside the container. You can choose the folder you want to map.

You can use all the options of api-scenario (see the documentation for the complete options list⁠)

⁠Find Us

• GitHub⁠

⁠Want to contribute

We love to see contributions to the project and have tried to make it easy to do so.

Please follow our contribution guidelines⁠ and open your first PR.

⁠Versioning

We use SemVer⁠ for versioning. For the versions available, see the releases on this repository⁠.

⁠Authors

• Thomas Poignant - GitHub⁠
• Ahmed Ftouh - GitHub⁠

See also the list of contributors⁠ who participated in this project.

⁠License

This project is licensed under the Unlicense - see the [LICENSE](LICENSE.md⁠ file for details.