Import an API definition for an external API
Prerequisites
-
For Planet 9 files: you must have previously exported a Planet 9 file of an API definition from the API Designer of your Neptune DXP - Open Edition system for the API Designer to recognize the Planet 9 file during import.
Procedure
-
In the Cockpit, select the API Designer.
Result: A table of existing API definitions is shown.
-
Select Add.
Result: You start in the General tab.
-
In Type, select External.
-
In API Format, ensure that you set the API format in accordance with the format supported by your API server.
-
In Name, enter a meaningful name for the API.
-
In Endpoint, add the URI for the endpoint.
-
Select Save.
-
Select Import and select an option from the drop-down menu:
-
To import a file from your disk, select Planet 9 File.
Result: Your local file explorer opens.
-
Go to the directory of the file, select the file, and select Open.
-
-
To import a definition in JSON or YAML, select Open API 3.0.
Result: The Import API dialog opens.
-
Write or paste the definition into the editor.
-
Select Import.
-
-
To import an API from the connected API Factory of a remote system instance of the Neptune DXP - SAP Edition, select SAP api.
Result: The Import API dialog opens. You can see all APIs that are available to you.
-
Select the API that you want to import, select either JSON or YAML, and select Import.
Result: The API Designer enters a name, operations, and definitions for the API. You can still add, change and delete settings that were made by the API Designer.
-
-
To import an API from a remote system instance of the Neptune DXP - SAP Edition or another remote system via the API Discovery Service, select API Discovery Service.
Result: The API Discovery Service dialog opens and existing remote systems in the API Discovery Service are shown.
-
Select the relevant remote system and the API that you want to import.
Result: The selected API endpoint is entered automatically in the Endpoint field.
-
Select Import.
-
-