Creating, publishing, and testing a draft API

Use the API Agent to create, publish, and test a draft API from an existing OpenAPI document. The tool guides you through selecting a file, publishing to the Sandbox catalog, and running test cases, helping you validate your API before deployment.

Procedure

  1. Log in to API Agent. For more information, see Getting started.
  2. Enter the following prompt: 
    Create a draft api from @
    and select the required file.
    Note: Entering @ after the prompt displays a list of OpenAPI documents available in your workspace.
  3. Click Send. The API Connect Task tool communicates with the API Agent sources and displays the proposed plan.
  4. Click Start to view the following options and take the corresponding actions:
    • Download
    • Validate
    • Publish
  5. Select the Publish option, and click Send. The tool displays the proposed plan that shows where the API will be published.
    Note: The Sandbox catalog is a default catalog in the API Agent sources.
  6. Click Start. API Agent displays a message indicating that the API is published successfully.
  7. To download the published YAML file, click the download icon.
  8. To test the draft API, perform the following actions:
    1. Create test case
    2. Run test case