Configuring projects folder

Learn how to configure the projects folder to define where IBM API Studio stores and manages project files.

About this task

When you work in local mode, all your project files are stored on your computer. The projects folder acts as a centralized location where IBM API Studio stores and retrieves project files.

A well-structured projects folder simplifies tasks such as backing up, sharing, or archiving projects. By establishing a dedicated directory, you can avoid file conflicts, maintain clear organization, and streamline your workflow for local project development.

On first launch, the Welcome page opens to configure storage options, such as setting up the projects folder or VCS. You can access the same setup later from API Studio settings on the home page.

Procedure

  1. Click API Studio settings on the home page to open the settings menu.
  2. In the Projects folder tab, click Add projects folder.
    A dialog box appears to set up the projects folder.
    Note: Google Chrome and Microsoft Edge support the Projects folder option. Other browsers disable this option and restrict file or folder selection, limiting access to existing APIs and projects.
  3. In the Add projects folder dialog box, complete the following steps:
    1. Click Browse and select a folder on your computer.
      Note: When you select a folder, a pop-up requests edit access. Granting access allows IBM API Studio to use only the selected folder, keeping other files on the local file system secure.
    2. Provide a unique folder name for the projects folder.

    This folder serves as the base directory for saving all API projects.

  4. Click Add.

    IBM API Studio creates the new folder and lists it under the Projects folder section. You can create multiple projects within this folder. When you create a project, IBM API Studio generates the .apistudio-projects file in the folder.

    This file stores essential metadata about the project, allowing IBM API Studio to load, manage, and maintain its structure. IBM API Studio uses this file to recognize the project and its associated APIs and policies when you open the project.