Contents

Popular
 Contents

WSDL projects are used to convert SOAP-based APIs to RESTful APIs. This option allows to add a proxy project with an existing WSDL service.

Adding the Project

To add a WSDL Project, click the From WSDL option under Add API Project.


Figure 1: Navigating to create project from WSDL

Providing Basic Attributes

Provide values for the properties in the New WSDL Project dialog box.


Figure 2: New WSDL Project dialog box to enter details of WSDL Service

PropertyDescription
Display NameA name to act as Project ID to identify the WSDL project.
VersionRevision number of the project, for example, 1.0 for a project being newly added and 1.1 or 2.0 for the next revision.
Proxy Context Path

A text used to combine with the version number to act as an identifier to map with a particular deployed project. The proxy resolves context path mappings prior to applying any matching policies (explained in subsequent topics).

Icon
  • Proxy Context Path combined with version number must be unique for every project.
  • Different versions of the same project (same project name with different version number) can have the same Context Path.
Secure API with

Enables security to the requests with the following security options:

  • None: No authentication checks will be done.
  • API Keys: Checks for the authentication key which gets generated for API Product (as explained in the last portion of "Adding Products, Clients and Client Subscriptions section" in the Quick Start page.
  • OAuth 2.0 Access Tokens: Protocol used for for authentication and authorization.
Enforce QuotaWhether or not to enable the default Quota policy. (Quota policy will be explained in the later sections)
WSDL Type

URL or File; WSDL can be selected using the URL of the service or by accessing the WSDL file saved in the system.

WSDL Service URL/
File Path 

WSDL Service URL appears if URL is selected as WSDL Type and File Path for File WSDL Type.

Provide URL of the WSDL Service or the location where the WSDL file has been saved.

Load Operations

After providing WSDL Service URL, click the Load Operations button to populate the operations used in the chosen WSDL.


Figure 3: New WSDL Project dialog box to enter details of WSDL Service

Select Type (REST-SOAP/SOAP), select the operation that is required, and then you may click Finish to create the project, or click Next to:

  • Add Security policy or to add Quota policy.
  • Attach an existing product to this new project. 

Enabling Security and Quota

Generally, policies are created for a project after adding the project, but Security policy and Quota policy can be created while creating a project itself. To do this, click Next from the basic properties screen and select the attributes accordingly.


Figure 4: Options to provide security attributes and enforce Quota

After entering the above details, you may click:

  • Finish to create the project
  • Next to attach a product to this new project.
Icon

If you need to amend the basic details that you had entered, click Previous button to move back to the first screen.

Attaching a Product to the Project

The existing projects get reflected in the Attach to API Policy drop-down list; select the respective product to attach it to the project.


Figure 5: Option to attach existing product(s) to the project

 

Icon

If you need to amend the Security/Quota details that you had entered, click Previous button to move back to that screen.

Adaptavist ThemeBuilder EngineAtlassian Confluence