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

GITBOOK-1: No subject

Browse Source
This commit is contained in:
Cesareo Macias
2025-02-12 16:37:20 +00:00
committed by gitbook-bot
parent 1b52a38e90
commit a6d7fc63de
4 changed files with 53 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
rest-api-guidelines/guides/api-testing-ci-environment.md
View File

@@ -1,28 +1,27 @@
# API Testing CI Environment
This guide describes steps necessary for testing an API described in a swagger file with the [Dredd API Testing Framework](https://github.com/apiaryio/dredd) in a CI Environment \(Jenkins, TeamCity\).
This guide describes steps necessary for testing an API described in a swagger file with the [Dredd API Testing Framework](https://github.com/apiaryio/dredd) in a CI Environment (Jenkins, TeamCity).
## Environment Prerequisites
The following must be available in the CI environment before testing:
1. **Node.js** runtime MUST be available in the CI environment:
1. **Node.js** runtime MUST be available in the CI environment:
```text
$ node -v
v14.15.5
```
```
$ node -v
v14.15.5
```
2. [**Dredd**](https://github.com/apiaryio/dredd) MUST be installed globally in the CI environment:
3. [**Dredd**](https://github.com/apiaryio/dredd) MUST be installed globally in the CI environment:
```
$ npm install -g dredd --no-optional
```
```text
$ npm install -g dredd --no-optional
```
```text
$ dredd --version
dredd v14.0.0
```
```
$ dredd --version
dredd v14.0.0
```
## Testing an API
@@ -30,23 +29,22 @@ The following must be available in the CI environment before testing:
To test an API within the CI environment provisioned as mentioned in the environment prerequisites, you will need the following:
1. A `swagger.yaml` file with the description of API being tested
1. A `swagger.yaml` file with the description of API being tested
The OpenAPI Specifciation file should be fetched from [API Design Platform](design-plaform.md). In the case of SwaggerHub API Design Platform, the file can be fetched manually or via their API. Refer to [Integrating with the SwaggerHub API](https://swagger.io/blog/api-development/integrating-with-the-swaggerhub-api/), for details how to use SwaggerHub API.
The OpenAPI Specifciation file should be fetched from [API Design Platform](https://github.com/cesareomacias/api-guidelines/blob/master/rest-api-guidelines/guides/design-plaform.md). In the case of SwaggerHub API Design Platform, the file can be fetched manually or via their API. Refer to [Integrating with the SwaggerHub API](https://swagger.io/blog/api-development/integrating-with-the-swaggerhub-api/), for details how to use SwaggerHub API.
Alternativelly this can also be a remote file e.g. SwaggerHub URL, if the API is public its OAS file and reachable from the testing host.
Alternativelly this can also be a remote file e.g. SwaggerHub URL, if the API is public its OAS file and reachable from the testing host.
2. The host (address) of the service being tested
2. The host \(address\) of the service being tested
```text
$ export API_HOST=http://deheremap7336.emea.adsint.biz:8004`
```
```
$ export API_HOST=http://deheremap7336.emea.adsint.biz:8004`
```
### Running the Test
Run:
```text
```
$ dredd swagger.yaml $API_HOST
```
@@ -54,8 +52,8 @@ $ dredd swagger.yaml $API_HOST
The Dredd will perform the tests and exits usually if the tests have passed. You can check the test result as with any other Unix tools with:
```text
```
$ echo $?
```
Everything else but `0` should break the build. The test results will be visible in the CLI \(log\)
Everything else but `0` should break the build. The test results will be visible in the CLI (log)