Creating APIs

The organization owner, organization admins, API designers, and API reviewers can create API designs in authorized organizations and projects (if exist). Depending on the created location, the API will be visible in the corresponding catalog.

You can either create API designs from scratch or import a predefined API design.

Manually creating APIs

To create a new API:

1. On the top bar, click CREATE > API > New API.

   
   

   Note that the New API dialog appears.

   
   

2. Under DETAILS, enter API details as given below.

   📃

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

   Field	Description	Sample Value
   Open API version*	This is the OpenAPI specification version that will be applicable to your API.	3.1
   API version*	This is to identify the API version.	1.0
   API name*	This uniquely identifies the API within the corresponding catalog.	OrderManagementAPI
   Project*	This identifies the project under which the API is created. 💡 Tip: - If the API is created under a default organization, this will be set to default project. - If the API is created under a project, this will be set to the corresponding project name.	default project
   Collection path*	This is the catalog under which the API is created.	Orders Catalog
   Format*	This defines the format in which your API data will be structured. - JSON - YAML	JSON
   Protocol*	This defines the protocol that your API will use to communicate. - REST	REST
   Description	This describes your API purpose.	This is a private API located in the Orders Catalog.
   API tags*	This is to classify your API. Depending on the tags selected, the API can be filtered in API Hub.	Food
   Apply API Template	This applies a predefined API template for your API.	RESTful CRUD API Template

3. Click Next.

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

   
   

5. Click Next.

6. Under REVIEW, you may review the entered API details.

   
   
   💡

   Tip: You may change the entered API details by going back to the previous tab.

7. Click Create API. Upon successfully creating the API, note that:

   • You will be navigated to the editor view of your API.
   • Your new API will appear in the respective dashboard.
   • All authoriezd members will be notified via Activity Stream.

Importing existing APIs

To import a pre-designed API:

1. On the top bar, click CREATE > API > Import API.

   
   

   Note that the Import API dialog appears.

   
   

2. You may perform either of the following:

   • OPTION A: Drag and drop or browse the API file.
     📃

     Note: Only the YAML and JSON file formats are allowed.

   • OPTION B: Enter the corresponding base URL of the API.

3. Click Import. Note that the New Import API dialog appears.

   
   

4. Under DETAILS, your may update API details as given below.

   📃

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

   Field	Description	Sample Value
   Open API version*	This is the OpenAPI specification version that will be applicable to your API.	3.1
   API version*	This is to identify the API version.	1.0
   API name*	This uniquely identifies the API within the corresponding catalog.	OrderManagementAPI
   Project*	This identifies the project under which the API is created. 💡 Tip: - If the API is created under a default organization, this will be set to default project. - If the API is created under a project, this will be set to the corresponding project name.	default project
   Collection path*	This is the catalog under which the API is created.	Orders Catalog
   Format*	This defines the format in which your API data will be structured. - JSON - YAML	JSON
   Protocol*	This defines the protocol that your API will use to communicate. - REST	REST
   Description	This describes your API purpose.	This is a private API located in the Orders Catalog.
   API tags*	This is to classify your API. Depending on the tags selected, the API can be filtered in API Hub.	Food
   Apply API Template	This applies a predefined API template for your API.	RESTful CRUD API Template

5. Click Next.

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

   
   

7. Click Next.

8. Under REVIEW, you may review the entered API details.

   
   
   💡

   Tip: You may change the entered API details by going back to the previous tab.

9. Click Create API. Upon successfully creating the API, note that:

   • You will be navigated to the editor view of your API.
   • Your new API will appear in the respective dashboard.
   • All authoriezd members will be notified via Activity Stream.