API Execution/Testing

🕓 10 minutes

What you’ll learn#

How to execute components APIs and see the responses after the application deployment.

Before you begin#

Steps#

  1. See the application detail.
  2. Click on the Open in Browser on the chosen deployed application.
  3. Choose the application component for API execution.
  4. Execute your API’s by the integrated Swagger UI tool
    • Learn more about the Swagger UI on https://swagger.io/tools/swagger-ui/ or this youtube demo can also help.
    • Often you are looking for traceID from the response header. This traceID, e.g., helps you analyze interactions in distributed tracing systems.
    • If your swagger-ui does not reflect the latest changes in your component's API, make sure you modified the swagger.yml file inside your component.
  5. You can use traceID to see detailed logs of your application.
    • To be able to see them, you can go to the "Logging and tracing" section, choose "Logging" and paste your traceID into the query field in the appropriate format
      {traceId="your traceId"}
    • You can also change the time range if you click on the clock icon in the top right corner.
  6. TraceID is also used for analyzing your tracing system.
    • For tracing information, go to the "Logging and tracing" section, this time choose "Tracing" and paste your traceID into the input field.
    • Here you can see how components interact with each other inside your application.

Screenshots#

Step 1

api1

Step 2 and 3

api2_3

Step 4

api4_1

api4_1

api4_1

api4_2

Step 5

api5_1

api5_2

Step 6

api6_1

api6_2

api6_1

What’s next?#

You might be interested in our other tutorials: