Generating an API archive in the API toolkit

You can export your API project into an API archive (.aar) file from the API toolkit for deployment to the designated API directory. In an automated DevOps process, the API archive is usually generated by using the build toolkit.

Before you begin

zosConnect-2.0 Applies to zosConnect-2.0.

Make any final edits to the Swagger document. For example, you might want to add security and authentication requirements. Manual changes to the Swagger document are preserved when saved.

Take the following steps to generate the API archive from the API toolkit. For automated DevOps process by using the build toolkit, see

Procedure

  1. In the Project Explorer view, right-click an API project and click z/OS Connect > Export z/OS Connect API Archive.
  2. Specify the location where you want to save this API archive file. The default file name is the API name with a file extension of .aar.

Results

The API archive file is saved as a .aar file.

What to do next

Transfer the file to the API directory for your IBM® z/OS® Connect server. For more information, see Automated API management

Note: In a DevOps environment, the API archive is generated by using the build toolkit with the API project directory as input. For more information about the build toolkit, its zconbt command syntax, and samples, see zconbt command syntax.