[V5.0.3 or later]

Creating new projects with API Designer

You can create new LoopBack® and OpenAPI (Swagger 2.0) projects with the API Designer.

Procedure

To create a new project with 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. In the side bar, click the Projects Plus icon Plus icon.
  3. Depending on the type of project you want to create, follow the steps in Creating a new LoopBack project or Creating a new OpenAPI project.

Creating a new LoopBack project

Before you begin

To complete this task, you must have internet access, because LoopBack installs dependencies from the public npm repository. Alternatively, you can configure a private npm repository.

About this task

To create a new LoopBack project with the API Designer, first, complete the steps in the preceding section, then follow these steps:

Procedure

  1. Click Create LoopBack Project.
    You'll see the Add new LoopBack project dialog.
  2. Select a project template: one of api-server, empty-server, hello-world, or notes.
  3. For LoopBack Version, select either version 3.x (the current version) or version 2.x.
  4. Enter values for the Display Name, Name, and Project Directory fields.
    Note: API Designer creates a new directory called Name to contain the new project within the specified Project Directory. You cannot choose the directory where you ran apic edit as the Project Directory; If you do, you will see the error message "Path already in use."
  5. Click Add.

Results

The API Designer creates a new LoopBack project and makes the project available for editing.

Creating a new OpenAPI project

About this task

To create a new OpenAPI project with the API Designer, first, complete the steps in the preceding section, then follow these steps:

Procedure

  1. Select Create Open API project.
    You'll see the Add new OpenAPI project dialog.
  2. Enter values for Display Name, Name, and Project Directory.
    Note: API Designer creates a new directory called Name to contain the new project within the specified Project Directory. You cannot choose the directory where you ran apic edit as the Project Directory; If you do, you will see the error message "Path already in use."
  3. Click Add.

Results

The API Designer creates a new OpenAPI project and makes the project available for editing.