Adding a SOAP API definition by using a WSDL file

If a SOAP service owner provides you with the details of the service in a WSDL file, you can use the WSDL file to add a SOAP API definition. You can also provide a URL link to a location from which you can obtain the WSDL definition.

To add a SOAP API definition by loading a WSDL file, complete the following steps:

1. Click APIs.
   The APIs tab opens.
2. If you have not previously pinned the UI navigation pane then click the Navigate to icon .
   The API Manager UI navigation pane opens. To pin the UI navigation pane, click the Pin menu icon .
3. Click Drafts in the UI navigation pane, and then click APIs.
   The APIs tab opens.
4. Click Add > New OpenAPI from SOAP service.
   Click Add > API from WSDL.

   The New API from WSDL window opens.

5. To upload the service information from a stand-alone .wsdl file, a .zip file that contains a WSDL file and its dependent documents, or a registry, use one of the following options:
   • Click Upload file and browse for the .wsdl file or .zip file.
   • (.wsdl file only) Click Load from URL and then complete the WSDL URL field. If the URL is secured, you must provide the user name and password for accessing the URL. Click Next.
   • Click Find in registry to find the details for an existing SOAP service in a registry. For more information about using this option, see Adding a SOAP API definition by discovering a service from a registry.

   If you upload a .zip file, you can include in the .zip file an options file to specify additional directives. For details, see Using an options file when importing a WSDL service.

   All of the services that are contained in the WSDL file are displayed. The WSDL file might contain multiple service definitions. You can view all of those services and the operations for each service.

6. Specify the services to include, and then create the API definition.
   1. Select one or more of the services that you want to add as SOAP API definitions and then click Next.
   2. Optional: If you want to create a Product and include your SOAP API in the Product, select Create product and complete the Product name field.
   3. Click Done.
   Your SOAP API definition is created and displayed in the list of API definitions in the APIs tab of the Drafts page. You can edit the SOAP API definition by clicking its name in the list.
7. Specify the services to include, and then create the API definition.
   1. Select one or more of the services that you want to add as SOAP API definitions.

      You can then either choose to create a new Product and include your API in that Product, or create your API without adding it to a Product.

   2. If you want to create a Product and include your SOAP API in that Product, complete the following steps:
      1. Click Add a product.
      2. In the Product template field, select Default if you want to use the template defined as the default, to create the Product definition. This can either be the default .hbs template file provided with the developer toolkit, or another template file that you have configured as the default by using configuration variables. You can also select a custom template that you created. For information about template files and configuration variables, see Creating and using API and Product definitions templates and Toolkit command summary.
      3. Accept the default values for the Product title, name, and version, or change them as required.
      4. To publish the Product to a target Catalog, ensure that the Publish this product to a catalog check box is selected. You can clear this check box and stage or publish the Product later by using the API Designer UI and API Manager UI, as described in Staging a Product and Publishing a Product.
      5. Select the Catalog that you want to use.
      6. If Spaces have been enabled, select the Catalog and Space that you require.Your Product is staged to the Space that you selected.
      7. Click Done.
   3. If you want to create your API without adding it to a Product, click Done.
      Tip: You can add the API to one or more Products later, as described in Adding an API definition to existing Products.
   The Design tab for the draft of your API definition opens. You can skip to different sections of your API definition by using the page navigation in the side bar. You can view the OpenAPI (Swagger 2.0) definition of your API in the Source tab and, after you have created an assembly, view your policy assembly in the Assemble tab.