This option allows the addition of a proxy project to existing backend REST or HTTP services which can be used for request types: REST or HTTP respectively.
Adding the Project
To add a REST/HTTP Service project, click the Add API Project button and click the From REST/HTTP Service option.
Figure 1: Navigating to create project from REST/HTTP Service
Providing Basic Attributes
Enter values for attributes in the New Backend Service dialog box as described in the table below.
Figure 2: New Backend Service dialog box to provide details of REST/HTTP Service
Property | Description |
---|---|
Display Name | A name to act as Project ID to identify the project. |
Version | Revision number of the project. For example, 1.0 for a project being newly added and 1.1 or 2.0 for the next revision. |
Backend Service URL | URL of the service provider from where data is to be fetched after implementing the policies that are defined. |
Method | HTTP method used by the back end Service to send requests by using the following methods:
|
Proxy Context Path | This is a text used to combine with the version number to act as an identifier to map a deployed project. The proxy resolves context path mappings prior to applying any matching policies (explained in subsequent topics). |
Method | HTTP method used by the application to send requests to the proxy by using the methods GET/POST/PUT/DELETE as explained previously. |
After entering the above details, 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.
API Customization - Enabling Security and Quota
Generally, policies are created for a project after adding the project, while Security policy and Quota policy can be created while creating a project as well. 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
Property | Description |
---|---|
Secure API with | Enables security to the requests with the following security options:
|
Enforce Quota | Whether or not to enable the default Quota policy. |
After entering the above details, click:
- Finish to create the project
- Next to attach a product to this new project.
Product Mapping - Attaching a Product to the Project
The existing projects get reflected in the Attach to API Policy drop-down list. Select a product to attach it to the project.
Figure 4: Option to attach existing product(s) to the project