Testing an API

Select a test tool and verify that your API works as you intended.

Before you publish an API where customers can access it, you need to test it and ensure that it is defined and implemented correctly. API Connect offers tools for running both simple and complex tests, in different environments. Use the following list of options to choose the test tool that best meets your needs:

  • Execute and debug the API in the Test tab

    On the Test tab, you can quickly invoke your API from the API Connect UI with minimal preparation. The Test tab offers full control over the API call through a simple set of fields where you can define your request. The response includes both a visual flow diagram and a code trace that shows how the API’s process flow is executed.

  • Call the API externally from the Automated API behavior testing application as explained in Testing an API with Automated API behavior testing

    Automated API behavior testing provides a simple set of fields where you can quickly invoke your API. You can automate tests and define schedules for running them. You can even set up API monitoring and receive alerts on your API health before issues occur.

  • Run a simple test in the Assembly tab

    The Assembly tab's Test panel only supports the Sandbox catalog’s built-in client app, with its client ID and client secret. The Test panel you quickly set up and invoke the API, but offers limited control.

    Note: The Test panel is deprecated and might be removed without warning.