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:34:43 +00:00
parent 63f6aa8f42
commit f4628b04cc
1 changed files with 20 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -50,12 +50,15 @@ The following must be available in the CI environment prior to testing:
To obtain an Apiary API key, head to <https://login.apiary.io/tokens> (NOTE: You will need the "ALL" Scope)
## Testing an API
### Test Run Prerequisites
To test an API within the CI environment provisioned as mentioned in the environment prerequisites you will need the following:
1. The name (subodmain) of API project at Apiary
```
export APIARY_API_NAME=bomapi3
$ export APIARY_API_NAME=bomapi3
```
1. A `swagger.yaml` file with the description of API being tested
@@ -66,8 +69,23 @@ To test an API within the CI environment provisioned as mentioned in the environ
$ apiary fetch --api-name=$APIARY_API_NAME --output="swagger.yaml"
```
1. The host (address) of the service being tested
```
$ export API_HOST=http://deheremap7336.emea.adsint.biz:8004`
```
### Running the Test
With all of the above (`APIARY_API_KEY`, `APIARY_API_NAME`, `API_HOST`, set up and `swagger.yaml` file present in the current directory, run:
```
$ dredd swagger.yaml $HOST -r apiary
```
1. The HOST address of the service being tested.