[V5.0.2 or later]Adding an existing project to API Designer

You can add existing LoopBack and OpenAPI (Swagger 2.0) projects from the local file system and then edit them withAPI Designer.

About this task

You can add existing LoopBack and OpenAPI (Swagger 2.0) projects from the local file system and then edit them with API Designer.
Note: If the LoopBack project does not include OpenAPI definition files (in the project's definitions directory), you must run the apic loopback:refresh command to create them before adding the project.

Procedure

To add a LoopBack project into API Designer, complete the following steps:

  1. If you have not previously pinned the UI navigation pane then click the Navigate to icon The Navigate to icon.
    The API Manager UI navigation pane opens. To pin the UI navigation pane, click the Pin menu icon The Pin menu icon..
  2. Click Plus icon to the right of Projects.
  3. Select Add an existing project.
    You'll see the Add existing project dialog.
  4. Browse to the desired project directory.
  5. Click OK.
  6. Enter Display Name and Name for the project.
  7. Click Add existing project.

Results

The project is now available for editing in API Designer and is selected as the current project to edit.
Note: If the LoopBack project does not have OpenAPI definition files (in a definitions directory), you must run the apic loopback:refresh command to create them.

Adding an existing OpenAPI project

About this task

You can add an existing OpenAPI (Swagger 2.0) project from the local file system to the API Designer.
Note: Currently adding an OpenAPI project simply creates a new empty directory for the project. However, you can create API and product definitions for the project in the API Designer.

Procedure

To add an OpenAPI project to API Designer, complete the following steps:

  1. If you have not previously pinned the UI navigation pane then click the Navigate to icon The Navigate to icon.
    The API Manager UI navigation pane opens. To pin the UI navigation pane, click the Pin menu icon The Pin menu icon..
  2. Click Plus icon to the right of Projects.
  3. Select OpenAPI project.
    You'll see the Add existing project dialog.
  4. Browse to the desired project directory.
  5. Click Next.
  6. Enter Display Name and Name for the project.
  7. Click Add existing project.

Results

The project is now available for editing in API Designer and is selected as the current project to edit.

Selecting a project to edit

About this task

Once you have created a new project or added a project as described in Adding an existing project to API Designer and Adding an existing OpenAPI project, you can switch between different projects in API Designer.
Note: When you start API Designer in a project directory, that project is the initial current project.

Procedure

To select a project to edit, complete the following steps:

  1. If you have not previously pinned the UI navigation pane then click the Navigate to icon The Navigate to icon.
    The API Manager UI navigation pane opens. To pin the UI navigation pane, click the Pin menu icon The Pin menu icon..
  2. In the UI navigation pane, Projects lists all the projects you have created or added. Click the name of the project you want to edit.

Results

The project is now selected as the current project in API Designer and the project name is displayed in the main navigation banner.