Mirrors/api-guidelines
1
0
Fork 0
mirror of https://github.com/adidas/api-guidelines.git synced 2025-10-25 15:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updates guides/api-testing-ci-environment.md

Browse Source 
Auto commit by GitBook Editor
This commit is contained in:
apidesigner
2017-05-26 12:13:14 +00:00
parent 55c1637bc1
commit 21e70e76f4
1 changed files with 17 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
guides/api-testing-ci-environment.md
View File

@@ -1,16 +1,18 @@
# Jenkins CI Environment for Apiary Project
This guide describes steps necessary for testing an API with Dredd in a CI Environment (Jenkins, TeamCity).
This guide describes steps necessary for testing an API described in a swagger file with Dredd in a CI Environment (Jenkins, TeamCity).
## Preparation
1. The CI environment MUST have a Node.js runtime:
## Prerequisites
The following must be available in the CI environment prior to testing:
1. Node.js runtime:
```
$ node -v
v7.5.0
```
2. [Dredd](https://github.com/apiaryio/dredd) MUST be installed globally in the CI environment:
1. [Dredd](https://github.com/apiaryio/dredd) MUST be installed globally in the CI environment:
```
$ npm install -g dredd --no-optional
@@ -21,4 +23,15 @@ This guide describes steps necessary for testing an API with Dredd in a CI Envir
dredd v2.2.5 (Darwin 16.4.0; x64)
```
1. Apiary API Key
```
$ export APIARY_API_KEY=xyz
```
## Testing an API
1. A `swagger.yaml` file with the description of API being tested.
1.