Converting APIs to DataPower API Gateway

You can convert API Connect v5-compatible APIs to v10 DataPower® API Gateway.

Before you begin

Use the migration utility command apicm archive:port-to-apigw to convert v5-compatible APIs to DataPower API Gateway. For instructions on installing the migration utility, see Installing the migration utility.

You can convert your API definitions as part of the migration workflow, or as a separate task. Use these instructions to convert YAML source files separately. For instructions on converting APIs during migration, see Migration steps without PDUR.

The following steps are required before converting v5-compatible APIs to DataPower API Gateway. For detailed instructions on all of these tasks, see Migration steps without PDUR.

  • Download the latest IBM API Connect® Migration Utility (AMU) from IBM® Fix Central. The migration utility requires Installer Version 5.0.0 or later. However, if you intend to use it to convert APIs, use Installer Version 7.0.1 or later.
  • Ensure that the AMU version that you are using is supported by your versions of DataPower API Gateway and API Connect. For more information, see Configuring migration options for DataPower API Gateway.
  • Converting APIs using the migration utility requires Node version 14.21.3. Ensure that you have that version installed.
  • Run archive:unpack to unpack the V5 dbextract into v5-compatible artifacts.
  • Map v5 object names to v10 object names. If the names are preserved exactly between the v5 and v10 environments, this step can be skipped. The gateway service must be mapped to a DataPower API Gateway. For more information, see Migration mapping files.

For information about the differences between gateway types available in API Connect, see API Connect gateway types.

About this task

The migration utility command apicm archive:port-to-apigw provides assistance in converting v5-compatible APIs to DataPower API Gateway, rather than full migration. It generates an output API that is supported on API Gateway v10.

The conversion process annotates the YAML file and logs with information regarding the artifacts that it attempts to convert. For cases where additional information is available or further action is required, the YAML input file and logs contain links to documentation.

Because of differences between the programming models of v5-compatible APIs and DataPower API Gateway APIs, the command might not be able to convert all items. You might need to port these items to the API Gateway. In these cases, messages generated by the apicm archive:port-to-apigw command provide links to documentation that provides more details about changes you must make for these items to be compatible with DataPower API Gateway.

Procedure

Run the conversion command from the directory where you downloaded the utility.
Command syntax:
./apicm archive:port-to-apigw path

The path is the full path to the YAML file or directory. You can specify to convert a single YAML file or the contents of an entire directory.

The migration utility produces an output YAML file with the results of the conversion process.

What to do next

Review the output YAML file and make any necessary changes to ensure that your APIs are compatible with DataPower API Gateway. For more information, see Reviewing APIs converted to DataPower API Gateway

Push the converted YAML files to the v10 deployment. For details, see Migration steps without PDUR.