Quick Start Guide

Are you new to Xapi? Let’s do a quick start!

Being the flagship product of X-Venture (opens in a new tab), Xapi is a full-fledged API designing and governance tool that is carefully designed to manage API requirements, API designs, as well as the stakeholders.

Xapi stands out from the other API solutions out there by enabling the ability to manage note only APIs from their inception to going live but the crew that puts their heart and soul to make them a reality by using an abstraction called Organization. An Xapi organization is a virtual entity that can house APIs, API models, API projects, and even API teams that will be working on APIs.

Depending on the time and money you would want to spend on us, we have segregated three different types of quick starts:

Quick start to default Xapi Organization

This Quick Start Guide helps you to explore Xapi features with default organization that gets automatically generated when you sign up with Xapi.

What you will achieve This quick start guide helps you to:

• Step 1: Create APIs
• Step 2: Design APIs
• Step 3: Review APIs

Before you begin

1. Access the Xapi portal here Sign in (opens in a new tab).

1. Sign in. For instructions, see Signing in to Xapi. Note that the dashboard of your default Xapi organization appears.

Now that you have successfully signed in to Xapi, let’s create an API in your default organization!

Step 1: Create API

To create an API:

1. Click CREATE > API > New API.

   Note that the New API form opens.

2. Enter the API details.

   Open API version	3.1
   API version	1.0
   API name	Cofee Shop API
   Project	Default Project
   Collection path	Default collection path
   Format	JSON
   Protocol	REST

3. Click Create. Note that you will be navigated to the API editor screen.

Congratulations! You have successfully created your very first API with Xapi. Let’s flesh out your API design!

Step 2: Design API

To design the API that you created:

1. On the API editor screen and copy the following code snippet in the middle pain. Cofee Shop - Code Snippet (opens in a new tab)

2. Try adding coffee shop operations using the sample values.

Now that you have made edits to your API, let’s learn how to review and comment on API designs!

Step 3: Review API

To review and add comments to your API:

1. Place your cursor on a preferred line of the code in the central pane. Note that the Comment icon appears at the left.

2. Click on the Comment icon and add the following text.

3. Click Add. Note that your profile icon appears on the line that you commented.

This brings to the end of the Quick Start to Xapi default organizations. We recommend you to explore the following topics:

• Quick start to free organizations
• Quick start to premium organizations
• Managing your API team (Organizations, projects, and teams)
• Managing your APIs (APIs, models, catalogs, and collection paths)
• Managing your API requirements (features, improvements, bugs, kanban)

Quick start to Xapi Organization

This quick start guide helps you to explore free Xapi features by creating an Xapi organization from scratch.

Scenario

John Doe is the owner of a software development organization that has divisions:

• A division that maintains its own product suite for healthcare
• A division that does software development projects in different domains such as healthcare and insurance.

Both of these projects involve creating and maintaining APIs. Along with the software application evolution that takes place within the product and projects, the associated APIs also get numerous requests to improve (API requirements).

John Doe who intends to increase the overall productivity of the organization and its projects is interested in maintaining the following with Xapi:

• Organization
• Organization members
• Organization APIs artifacts
• Projects
• Project members
• Project APIs and artifacts

Let’s assume you are John Doe and check out how to manage the above-mentioned entities with Xapi!

What you will achieve

This Quick Start Guide guides you to:

• Step 1: Create an Xapi organization for John Doe’s organization
• Step 2: Invite organization members to John Doe’s organization
• Step 3: Create a project under John Doe’s organization
• Step 4: Assign team members to a project
• Step 5: Create APIs
• Step 6: Create Kanban ticket and attach API
• Step 7: View Kanban Board
• Step 8: Add comment to API

Before you begin

1. Access the Xapi portal at URL.

2. Sign in. For instructions, see Signing in to Xapi. Note that the dashboard of your default Xapi organization appears.

Now that you have successfully signed in to Xapi, let’s create an organization!

Step 1: Create an organization and invite members

To create a premium organization your software development organization:

1. Click CREATE > Organization.

   Note that the New organization form opens.

2. Select the Premium plan.

3. Enter the organization details and click Next.

   Organization name	XYZ Org
   Ailas	XYZOrg

   Note that you will be navigated to the INVITE tab.

4. Enter an email ID of a person whom you want to collaborate with via this Xapi organization and select an appropriate role, e.g., Admin.

• Click Next. Note that you will be navigated to the Avatar tab.
• Select a preferred avatar and click Next. Note that you will be navigated to the Review tab.
• Click Proceed to billing. Note that you will be navigated to the dashboard screen of your newly created Xapi organization.

The dashboard presents:

• Activity stream: This lists down the activities that takes place within your organization.
• Recent API catalogs: This displays the recently used API catalogs of your organization. Info: Xapi API catalogs enable grouping APIs, API models, and API collections. For more information on Xapi API catalogs, see Link.
• Recent projects: This displays the recently used projects of your organization. Info: For more information on Xapi projects, see Link

Now that you have successfully created a premium Xapi organization, let’s invite more members to your organization!

Step 2: Invite organization members

To invite more members to your premium organization:

1. Click on the profile icon and select Settings.

2. Click People.

   Note that you will be navigated to the People screen.

3. Click INVITE. Note that the Invite People screen appears.

4. Enter an email ID of a person whom you want to collaborate with via this Xapi organization and select an appropriate role, e.g., Member.

5. Click Invite.

Now that you have invited more members to your organization, let’s create a project under the organization you just created.

Step 3: Create project

To create a project under the organization that you created:

1. While remaining on the People screen, click CREATE > Project.

Note that the New Project form opens.

2. Enter the project details and click Next.

• Select a preferred avatar and click Next. Note that you will be navigated to the People tab.
• Enter an email ID of an organization member whom you want to select for this project.
• Click Next. Note that you will be navigated to the Review tab.
• Click Create Project. Note that you will be navigated to the dashboard screen of your newly created Xapi project.

The dashboard presents:

• API Collections: This widget displays the [API collections] in this project.
• Contributors and Stats: This widget displays the top project contributors and project stats.
• Activity stream: This widget displays the activities that takes place within your project.
• Tickets assigned to you: This widget displays all the tasks that are assigned to you in this project.
• Attachments: This widget displays if any files attached to this project.

Now that you have successfully created a project, let’s assign more members to your project!

Step 4: Assign project team members

To assign more members to your project:

1. On the Projects menu, click View all projects.

2. Click Add People in the project tile.

3. Enter an email ID of a person whom you want to collaborate with via this Xapi organization and select an appropriate role, e.g., Member.

4. Click Add Members.

Now that you have invited more members to your project, let’s create an API in your project.

Step 5: Create API

To create an API in your project:

1. Click CREATE > API > New API.

   Note that the New API form opens.

2. Enter the following API details and click Next.

   Open API version	3.1
   API Version	1.0
   API Name	Enter a preferred name.
   Project	Select the newly created project.
   Collection path	This is the [API repository] in which this API will be created.
   Format	JSON
   Protocol	REST

3. Note that you will be navigated to the Review tab.

4. Click Create API. Note that you will be navigated to the API editor screen.

Now that you have created an API, let’s learn how to create a [Kanban ticket] to enhance the newly created API!

Step 6: Create Kanban ticket and attach API

To create a Kanban ticket:

1. Click CREATE > Task.

2. Enter the following Kanban task details and click Create.

   Project	Select the newly created project.
   Task	Feature
   API	Select the newly created API.
   Title	Enter a preferred feature name, e.g., Add new verb.
   Priority	Select a preferred a priority.

Now that you created a Kanban ticket, let’s view the Kanban ticket in the Kanban Board!

Step 7: View Kanban Board

To view Kanban Board:

1. On the API Catalogs menu, select your project catalog.

2. Click Kanbn on the left-navigation pane.

   Note that the newly created Kanban ticket appears under the TO DO column.

3. Do the following updates to the ticket and close the ticket:

   • Select yourself as the Assignee.
   • Select the Status to Design in Progress.

Now that you have learned how Kanban Ticket state transition takes places, let’s learn how to comment an API.

Step 8: Add comment to API

To add a comment to an API:

1. Click on the search icon and search for your API.

2. Navigate to the API editor screen.

3. Select a code line in the central pane.

4. Click on the Comment icon.
5. To assign the comment to a user, click on the @ icon and enter a username. For testing purposes, you can add your own username.
6. Add a comment, e.g., Comment this line.
7. Click Add. Note that a notification appears.

Congratulations! You have successfully completed the Xapi Quick Start Guide!

What’s Next?

Learn more about:

• Organizations
• Projects
• APIs, Models, and Collections
• API Catalogs
• Kanban Board and Kanban Tickets