Testing an API flow

Test a flow for an API by using Designer Authoring.

Before you begin

Start Designer Authoring by running the Designer command as described in Starting Designer Authoring by running the Designer command.

Create a flow for an API by using Designer Authoring as described in Creating a flow for an API. When your flow is ready to test, the status of the flow in the API editor is displayed as "Draft (ready to deploy)"

About this task

When you create a flow for an API in Designer Authoring, you can test it before you deploy it or redistribute it to other users.

Procedure

The following steps show that an example of a model that is called myModel and an operation called Create myModel.

  1. Click Test API.
    The Test API panel is displayed.
  2. Click Test.
    The Designer, OpenAPI, and Test tabs are visible.
  3. Select Test and then click POST/myModel in the list of options.
    The operation Create myModel is displayed. The tabs Details and Try it are visible.
  4. Select Try it and enter your username and password.
  5. Click Generate
    The body of the test is populated.
  6. Click Send.
    The test results are displayed.
  7. Review the results, and click Stop test.
  8. Optional: Click Edit flow and retest as required.

What to do next

Export your flow as described in Exporting a flow.