The API Fortress plugin allows you to add an API testing build step in your Jenkins CI. There are multiple testing modes you can choose from, depending on your needs.
The key parameter that you need to retrieve from API Fortress for any mode is the Webhook URL, a uniquely generated URL representing a project. You can create them in the company settings of your API Fortress account.
There are 4 testing modes available. "Run single test" will run a single test, while the others will run suites of tests.
Run single test
You can run a single test by providing a test ID. Test IDs can be found in test interstitial pages.
You can run our "automatch" mode by providing a URL representing a certain endpoint. You can configure automatch patterns in the "Automatch" section of each test. Read more about automatch Here .
Run by tag
By running "by tag" you can run multiple tests, marked with a certain tag. Tags can be added and edited in the test details.
By running a full project, you'll be running all tests contained in the project.
The following options can apply to any mode.
The plugin can silently run (blocking = false), let the build continue with a success and inform you if the test failed using the various methods available. Or it can be actively determining the build success (blocking=true) so that the build will wait for the tests result and stop the build if the tests fail.
If checked no events will be stored within API Fortress. To be used in conjunction with "blocking".
If checked no alerts will be sent if the tests fail.
You can override up to 3 parameters in the test scope. These variables will appear within the test scope just like any other variable. Pretty useful if you're willing to override the domain of the service being tested (Ie. staging vs production).
Version 1.0 (Jul 12, 2017)
- Initial release