Creating an API by Importing an API from a URL

Edit online

Before you begin

You must have the webMethods API Gateway's manage APIs or activate/deactivate APIs functional privilege assigned to perform this task.

About this task

To create an API by importing an API from a URL

Procedure

  1. Click APIs in the title navigation bar.
    A list of available APIs appears.
  2. Click Create API.
  3. Select Importing API from URL.
  4. Type the URL from where the API is to be imported.
    Note: If you provide a secured endpoint, ensure that you have configured the Truststore for Outbound connections from the Administration > Security > Keystore/Truststore page.
  5. Select Protected to make the API a protected API and provide the required credentials.
  6. Type a name for the API name in the Name field.
    • If you provide an API name, this overwrites the API name mentioned in the uploaded file and the 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.
  7. Provide a description for the API in the Description field.
  8. Select the required type.
    The available types are OData, OpenAPI, RAML, Swagger, WSDL, and GraphQL SDL.
  9. Provide a version for the API in the Version field.
  10. Select the team to which the API must be assigned in the Team field.
    This field appears only when the Team feature is enabled. It displays only the teams that you are a part of. If you have the User management functional privilege, all teams are displayed. You can select more than one team. To remove a team, click the icon next to the team to be removed.
  11. Click Create.
    An API is created with default policies.

What to do next

Note:
  • Importing an API fails for an invalid WSDL file.
  • Creating an API by importing swagger files from an HTTPS URL that is using self-signed certificates might fail. To workaround this, you can set the system environment variable as: export TRUST_ALL=true, so that the invalid certificates are ignored. Be aware that setting this variable makes the swagger-parser ignore all invalid certificates too. So this workaround has to be used with caution.
  • To avoid encountering errors while parsing large responses from the native API, you have to change the enablesoapValidation property by commenting out the <parameter name="enableSoapValidation">true</parameter> in SAG_Install_Directory\IntegrationServer\instances\default\config\wss\axis2.xml and restart the server for the change to take effect.
  • Since the GraphQL API schema does not contain a native endpoint, you must manually update the Native endpoint URL in the API details section and the Endpoint URI in the routing policy after you create a GraphQL API.