This GitHub Action allows you to trigger the execution of RapidAPI Testing tests. This is especially useful during CI/CD to ensure new deployments are functioning as expected.

on: [push]

jobs:
  run_api_test:
    runs-on: ubuntu-latest
    name: Execute RapidAPI API Tests
    steps:
    - name: Execute Tests
      id: tstExec
      uses: RapidAPI/[email protected]
      with:
        test: 'YOUR_TEST_ID'
        location: 'AWS-US-WEST-2'
        environment: 'ENV_ID(OPTIONAL)'
    - name: Show Results
      run: echo "The test took ${{ steps.tstExec.outputs.time }}ms to run"; echo "The test result was ${{ steps.tstExec.outputs.computedStatus }}"; echo "View Report - ${{ steps.tstExec.outputs.reportUrl }}"

Required The ID of the test you wish to execute.

Required The location the test will be executed in. Options:

• AWS-US-EAST-1 : N. Virginia
• AWS-US-WEST-2 : Oregon
• AWS-AP-EAST-1 : Hong Kong
• AWS-AP-SOUTH-1 : Mumbai
• AWS-AP-SOUTHEAST-1 : Singapore
• AWS-AP-NORTHEAST-1 : Tokyo
• AWS-EU-CENTRAL-1 : Frankfurt
• AWS-EU-WEST-3 : Paris
• AWS-SA-EAST-1 : São Paulo

The environment you want to run the test in. If you don't use environment omit this parameter

The tenant to run the test against. Defaults to the public Hub rapidapi.com. For example for an enterprise it may be tenant: ${ENTERPRISE_DOMAIN}.hub.rapidapi.com. Likewise, for different regions:

US: https://acme.hub.rapidapi.com
CA: https://acme.hub-ca.rapidapi.com
EU: https://acme.hub-eu.rapidapi.com

With acme being a mock domain used as an example.

The time it took the test to execute, in milliseconds (1000ms=s)

True/false based on the result of the test execution

URL of a human-readable report of the test execution

A human-readable test status that matches the status values on the test dashboard in the UI

For any help using this integration, reach out to [email protected]. You can also see RapidAPI Testing Guide in our Help Center.