Importing existing API Studio project

Import a full project previously built in IBM API Studio to restore, share, or continue working across environments.

About this task

When you import an IBM API Studio project from an archive:

  • IBM API Studio treats each valid root-level directory with a metadata file as a separate project.
  • If the archive contains multiple root-level directories, IBM API Studio imports each directory as a separate project.
  • IBM API Studio preserves each project’s structure as defined in the archive.

Procedure

  1. Click New API project > Import project or file on the home page.
    The Import screen appears.
  2. Select Existing API Studio project and click Next.
  3. In the Upload ZIP file section, drag files into the upload area or click to upload.
  4. Select the Override assets checkbox when there are assets with the same name that you want to be overwritten.
    You can select this option when you import the different versions of the same project to the same environment again. When you import an updated version, and you select the checkbox, then the existing assets are replaced with the imported assets. In such cases, any local changes are lost.
  5. Choose the storage location for the project.
    • Native storage. No configuration required.
      Note: This option is not available in the desktop app.
    • Repository. Select a repository you have already configured. After you select a repository, choose the relevant Branch. If you don’t see any repositories, configure a repository before continuing. For more information, see Configuring version control system.
    • Local storage. Select a local directory you have already configured. If you don’t see any local directories, configure and enable access to your projects folder first. For more information, see Configuring projects folder.
      Note: Google Chrome and Microsoft Edge support the Local directory option. Other browsers disable this option and restrict file or folder selection, limiting access to existing APIs and projects.
  6. Click Import.

    The selected project is imported to the specified storage system. An Import report appears and lists the imported file types and their import status.