Software AG Products 10.11 | Administering API Portal | Managing APIs | Importing an API by Uploading an API
 
Importing an API by Uploading an API
API Portal offers direct API importing facility for standalone scenarios when you do not have CentraSite or Mediator installed.
Prerequisite
You must have the API Provider or API Administrator role.
*To import an API by uploading an API
1. Click in the right top corner of the API Portal window to display the menu options.
2. Click Manage APIs. The Manage APIs page that lists all the APIs is displayed.
3. Click Import API.
4. Click Upload APIUpload API.
5. Click Browse.
6. Select the required file and click Open.
The Swagger parser is a self-contained file with no external references and can be uploaded as is.
If the RAML file, that is to be imported, contains external references, the entire set of files must be uploaded as a zip file with a structure as referenced by the RAML file.
For WSDL, if it is a single .wsdl file, it can be uploaded as it is. If the wsdl file contains reference schema, the entire set of files must be uploaded as a zip file with a structure as referenced by the WSDL file. If there are multiple .wsdl files in the zip file, then you have to provide the root file name.
7. Select the type.
The available types are OpenAPI, RAML, WSDL, or user-defined. By default, the options available are RAML, OpenAPI, and WSDL.
8. Type the API name you want the API to be displayed as.
If you provide an API name, this overwrites the API name mentioned in the uploaded file and imported API is displayed with the name provided.
If you do not provide an API name, the API name mentioned in the uploaded file is picked up and the API is displayed with that name.
If you do not provide an API name and the uploaded file does not have an API name mentioned then the API is displayed as Untitled.
9. Select the API Provider.
The imported API is associated with the API Provider selected. If a provider is not selected, by default the API is associated with the Default Provider.
10. Click Import API.
11. Click Close.
The imported API is now listed in the list of APIs.
You can use the Delete option to delete an API and the Edit option to update the API. The Edit option is available only for the directly imported APIs.