User Guides

Creating a project

To create a project:

  1. On the top ribbon, click CREATE > Project.

    Create project button

    Note that you will be navigated to the New Project dialog-box.

    a. Under Details, enter project details as given below.

FieldDescriptionSample Value
Project name*This uniquely identifies the project.Order Handling
DescriptionThis is the description of the project.The Coffee Order API is a RESTful API that enables customers to place and modify their coffee orders via mobile devices or web applications. This project includes features such as order customization, payment processing, and order tracking.
Project-Level API catalogThis is to indicate whether this project should have a dedicated project-level API catalog or not.
Note: Enabling this will result in all APIs, models, and collections that you create under this project being listed under the corresponding project API catalog(inside API catalogs).
Tip: You may enable this later via Project Dashboard.
Kanban board template*

This specifies the Kanban board template of your project:

  • None: This disables the project board template.
  • Standard Kanban Board: This is the standard Kanban board template provided by Xapi.
  • πŸ’‘
    Tip: Kanban board enforces effective API requirement management in your project.
    Standard Kanban Board
    Task Alias*

    This labels the project.

    Note: This will prefix all the tasks that are created under the project.

    Note: Fields marked with asterisk (*) are mandatory.

    1. Click Next

    2. Under AVATAR, you may either upload an avatar or select an existing avatar.

    d. Click Next

    e. Under PEOPLE, you may invite organization members or consumers to join this project as given below.

    FieldDescriptionSample Value
    Member nameInvite users by entering the email or username.
  • For existing Xapi users, enter the username (@username).
  • For non-Xapi users, enter the email.
  • πŸ“ƒ
    Note: You can invite up to eight individuals at a time.
  • Existing Xapi users: @johndoe
  • Non-Xapi users:
  • Member role

    This is the user role that the invitee will assume in this project:

  • API Reviewer
  • API Designer
  • ℹ️
    Info: To learn more about project roles, see project users.
    API Reviewer

    f. Click Next.

    g. Under REVIEW, you may review the entered details.

    h. Click Create Project.

    Note that you are navigated to the Project Dashboard.

    Image description

    What’s next?