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
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:
-
If you have not previously pinned the UI navigation pane then
click the Navigate to icon .
The API Manager UI navigation pane opens. To pin the UI navigation pane, click the Pin menu icon .
- Click to the right of Projects.
- Select Add an existing project. You'll see the Add existing project dialog.
- Browse to the desired project directory.
- Click OK.
- Enter Display Name and Name for the project.
- Click Add existing project.
Results
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
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:
-
If you have not previously pinned the UI navigation pane then
click the Navigate to icon .
The API Manager UI navigation pane opens. To pin the UI navigation pane, click the Pin menu icon .
- Click to the right of Projects.
- Select OpenAPI project. You'll see the Add existing project dialog.
- Browse to the desired project directory.
- Click Next.
- Enter Display Name and Name for the project.
- Click Add existing project.
Results
Selecting a project to edit
About this task
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:
-
If you have not previously pinned the UI navigation pane then
click the Navigate to icon .
The API Manager UI navigation pane opens. To pin the UI navigation pane, click the Pin menu icon .
- 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.