Resources Endpoint Flow

In Fiorano API Framework, data flows in the following manner:

  • App to Target
    • Proxy Request: Request passes from App to API Proxy.
    • Target Request: Request passes from API Proxy to Target.
  • Target to App
    • Target Response: Response passes from Target to API Proxy.
    • Proxy Response: Response passes from API Proxy to App.

Every resource that gets added for various purposes has the above structure and policies can be attached to any part (endpoints) of the flow, as per requirement.

Figure 1: Resources endpoints and the flow

Click the Resources  icon on the left side of the API Projects screen to manage resources.


Resources screen will be prepopulated with a default resource.

Adding a Resource

A new resource can be added by clicking the Add  icon. Attributes that need to be added are described below.

Figure 2: Dialog box to add new resource

Resource IDProvide a unique resource name.
PathContext path to the resource.

Click to select one of the methods: Get, Post, Put, and Delete.

The new resource will be added with Resource Configuration screen displayed (see the figure below).

Resources can be configured using the four screens below:

Resource Configuration

Configuring Context Variable on App

A rule will be created by default with the base path and method (Get/Post/Put/Delete) as chosen (see the figure under the Adding a Resource section above) while adding the resource.

Enable the following as required:

  • Forward base path to target
    When the resource base path, which includes path parameter values, has to be passed to the target as input, it can be appended to the target URL by selecting this option.
  • Accept child paths
    When multiple resources have URLs starting with the same context path, the resource with the exact match of the resource base path is fetched by default. But if a particular resource, for example, base path is /accounts/{accountId} needs to be chosen for any of its branched resources with resource base path as /accounts/{accountId}/balance, select the Accept child paths option.

Refer to the Configuring Rule section to attach a rule to the application by setting the Identifier Type and variable.


Add more elements to configure multiple conditions.

Target Configuration

Configuring Load Balancing and Streaming on Target

The targets that are configured in the Targets section appear here.

Figure 10: Configuring Load Balancing

Policy Configuration

Policies that are configured can be added to the resource to any endpoint in this section.

Viewing the policy execution order

Click the View policy execution order Expand  icon to see the graphical representation of policy execution order.

Adding policy to a resource

Perform the following in the Policy Configuration section:

  1. Click the Add  icon.
  2. Click the resource to view four editors on the right side - Resource Configuration, Target Configuration, Policy Configuration, and Open API Paths.
  3. Go to Policy Configuration, select the endpoint to which the policy needs to be added and click the Add  icon to add the policy.
  4. Add the required policies (already added policies) from the list of policies and click OK.

  5. Policies will be added and get displayed under Policy Configuration. Click the Save  icon to apply the changes and to attach the policy to the required resource endpoint.

  • To remove a policy from the endpoint, click the Delete icon next to the Add icon.
  • The arrow mark indicates the order in which the policies get executed.

To display the policy name under the policy icon, viewing the configuration of the added policy and Sorting the added policies, refer to the Project Level Policies section.

Open API Paths

WAF Configuration

To configure Web Application Firewall, select the Enable Web Application Firewall (WAF) option and follow the instructions in the Configuring Web Application Firewall section.

Adaptavist ThemeBuilder EngineAtlassian Confluence