Contents

Popular

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expandpanel
titleContents

Table of Contents
indent15px
stylenone

This option allows to add the addition of a proxy project to an existing backend REST or HTTP services which can be used for the request types: REST or HTTP respectively.

...

Adding a REST/HTTP Service project

To add a REST/HTTP Service project, click the Image Removed Add API Project button the Add Image Added icon and click the From REST/HTTP Service option.

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

Providing Basic Attributes

Enter values for attributes in the New Backend Service dialog box as described in attributes following descriptions in the table below.

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

PropertyDescription
Display NameA name to act as Project ID to Project display nameProvide a name to represent and identify the project.
VersionRevision number of the project, for . For example, 1.0 for a project being newly added and 1.1 or 2.0 for the next revision.
Backend Service 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.
MethodTarget 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.

Image Removed
Figure 3: Options of HTTP Method

Proxy Context PathA Proxy context path

This is 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).

Note
  • 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.
MethodProxy methodHTTP method used by the app application to send requests to the proxy by using the methods GET/POST/PUT/DELETE as explained previously. 

After enetering entering the above details, you may click Finish to create the project, or click Next to:

...

Generally, policies are created for a project after adding the project, but while Security policy and Quota policy can be created while creating a project itselfas well. To do this, click Next  from the basic properties screen  and select the attributes accordinglyas described in the table below.

Image RemovedImage Added
Figure 4: Options to provide security attributes and enforce Quota

PropertyDescription
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 an 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 Tokensaccess tokens: Protocol used for for authentication and authorization.
Enforce QuotaWhether or not to enable the default Quota policy.

After entering the above details, you may click:

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

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

Anchor
Product Mapping
Product Mapping
Product Mapping - Attaching a Product to the Project

The existing projects get reflected in Select a product to attach to the project from the existing projects listed under the Attach to API Policyproducts drop-down list; select the respective product to attach it to and click Finish to save the project. Image RemovedThe project gets added to the API Projects screen.

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

 

...

The project gets added to the API Projects 

Image Added

Figure 5: Project added to the API Projects screen

Adaptavist ThemeBuilder EngineAtlassian Confluence