The IBM API Connect Developer Toolkit offers a powerful command-line interface (CLI) equipped with a wide range of commands designed to support development, debugging, testing and publishing of APIs. Many of these commands require users to provide a payload file as an argument. To enhance the usability of the Toolkit and improve the developer experience, we have introduced payload examples, making it easier than ever for users to understand and work with API payloads.

The New Feature: Payload Examples

To simplify the user experience, we have enhanced the toolkit CLI by providing structured payload examples for various commands. These payload examples include actual keys with sample values, highlighting possible key-value pairs that can be included. This helps users understand the expected format and contents of payload files. Users can modify values as needed, making customisation easier.

Accessing Payload Examples

When using a command that requires a payload file, the toolkit now provides an example payload structure along with the help text. This ensures that users can easily view the expected format without referring to external documentation. Payload examples are provided not only within the toolkit CLI under the help text , but also in the toolkit docs. The payload examples are provided in YAML format.

For instance, if you need to create a user registry, you can refer to the payload example provided in the help text. Detailed payload examples for all supported user registry types - such as LDAP, LUR, AuthURL, and OIDC are available under the payload examples section.

Key Benefits

• Clear Syntax Guidance:
  Users can see structured examples showcasing possible key-value pairs

• Improved user experience: 

  users no longer need to manually search through schemas and documentations to determine the correct payload structure. Thus, reducing effort and improving efficiency.
  

• Reduced Trial and Error:
  Reduces guesswork, allowing users to run commands correctly without repeated attempts.

This new enhancement makes the IBM API Connect Developer Toolkit CLI more user-friendly by providing clear and structured payload examples.

Try it out and simplify your API development process!

Reference:

https://ibm-apiconnect.github.io/clidocs/