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, go to Connectivity and select API Designer.
-
In the API Designer, select Add.
Result: The API configuration dialog opens. You start in the General tab.
-
In Type, select External.
-
If you want to import a definition in Open API 3.0 format, select it in API format.
-
Select Import and select an option from the drop-down menu:
-
Select Planet 9 File to import a file from your disk.
Result: Your local editor opens.
-
Go to the directory of the file, select the file, and select Open.
-
-
Select Open API 3.0 to import a definition in JSON or YAML.
Result: The editor opens.
-
Write or paste the definition into the editor.
-
Select Import.
-
-
Select SAP api to import an API from the connected API Factory of a remote system instance of the Neptune DXP - SAP Edition.
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.
-
-
-
Select Save.