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 a REST/HTTP Service project

To add a REST/HTTP Service project, click the Add  icon and click the From REST/HTTP Service option.

Figure 1: Navigating to create a project from the REST/HTTP Service

Providing Basic Attributes

Enter values for attributes following descriptions in the table below.

Figure 2: New Backend Service dialog box to provide details of REST/HTTP Service

Project display nameProvide a name to represent and identify the 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.
Use proxy as endpointUse this option if proxy requests are not to be forwarded to the target.
Target backend service URLURL of the service provider from where data is to be fetched after implementing the policies that are defined.
Target method

HTTP method used by the back end Service to send requests by using the following methods:

  • GET: Requests data from a specified resource
  • POST: Submits data to be processed to a specified resource
  • PUT: Uploads a representation of the specified URI
  • DELETE: Deletes the specified resource
  • PROXY: The same method that the client uses to invoke the proxy server will be used to invoke the target server.
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).

  • 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.
Proxy methodHTTP 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 and select the attributes as described in the table below.

Figure 4: Options to provide security attributes and enforce Quota

Secure API with

Enables security to the requests with the following security options:

Enforce QuotaWhether 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.

To amend basic details entered, click the Previous button to move back to the first screen.

Product Mapping - Attaching a Product to the Project

Select a product to attach to the project from the existing projects listed under the Attach to API products drop-down and click Finish to save the project. The project gets added to the API Projects screen.

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

The project gets added to the API Projects 

Figure 5: Project added to the API Projects screen

Adaptavist ThemeBuilder EngineAtlassian Confluence