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:27:42 +00:00
parent 5ff6936ea2
commit 81a3388729
1 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -52,18 +52,21 @@ The following must be available in the CI environment prior to testing:
## Testing an API
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
```
1. A `swagger.yaml` file with the description of API being tested
To fetch the swagger.yaml file from Apiary run the following command before the test:
```
$ apiary fetch --api-name="<API_NAME>" --output="swagger.yaml"
$ apiary fetch --api-name=$APIARY_API_NAME --output="swagger.yaml"
```
For example: `$ apiary fetch --api-name=bomapi3 --output="swagger.yaml"
`
1. The name (subodmain) of API project at Apiary
1. The HOST address of the service being tested.