It is the interface where the list of API Proxies is displayed and any of them can be selected to perform various operations.

The API Proxy list is displayed as follows.


Clicking the value in the Name column of any record in the list opens the configuration interface for that API Proxy. For configuration details, see the Tabs section. 

In the URL column in the list, the environments and the addresses where the relevant API Proxy is installed and active are displayed. You can go to any address by clicking on it or copy the address by clicking the icon next to it.

There is a menu icon at the right most column of each line. Various operations can be performed from the menu that opens by clicking this icon.


Operations that can be done in the API Proxy List interface:

Filtering API Proxies

The default view has quick filter fields just above the list. If the default filter fields are not sufficient, Advanced Filtering options can be opened by clicking the icon in the red circle in the following image.

If a value is written or selected in any of the filter fields, the list below is updated according to the filter.


Advanced filtering options;

FieldDescription

Search by API Proxy name

API Proxy records, of which name contains the value entered in this filter field, are displayed. It is case-insensitive.

Search by API Proxy description

API Proxy records, of which description contains the value entered in this filter field, are displayed. It is case-insensitive.

Search by API Proxy relative path

API Proxy records, of which relative path contains the value entered in this filter field, are displayed. It is case-insensitive.

Search by Method name

API Proxy records with at least one method of which name contains the value entered in this filter field, are displayed. It is case-insensitive.

Search by Method description

API Proxy records with at least one method of which description contains the value entered in this filter field, are displayed. It is case-insensitive.

Status

Filters records on their deployment status.

Options:

  • All
  • Deployed: Those that have been deployed in at least one Environment and are in active state.
  • Not Deployed: Those that have not yet been deployed in any environment or undeployed.

Usage

Filters records through the usage pattern field.

Options

  • Unspecified: All
  • Publisher: API Proxies created for the external clients.
  • Consumer: API Proxies created for the internal clients.
  • Publisher & Consumer: API Proxies created for external and internal use.

Search by Parameter name

API Proxy records with at least one parameter of which name contains the value entered in this filter field, are displayed. It is case-insensitive.

Search by Parameter description

API Proxy records with at least one parameter of which description contains the value entered in this filter field, are displayed. It is case-insensitive.

Category

Filters records by category.


API Type

Filters records by protocol type.

Options:

  • SOAP: API Proxies published in SOAP protocol.
  • REST: API Proxies published in REST protocol. Even SOAP Web Services can be published in REST.

API Spec Type

Filters records by the type selected when creating the API Proxy.

Options:

  • Swagger
  • WSDL
  • Open API/Swagger 3.0.x
  • WADL
  • Fake API
  • Reverse Proxy
  • Mirror API
  • Empty API
  • DB-2-API
  • Script-2-API
  • Mock API


Importing an exported API Proxy 

Some companies/institutions may prefer to use installations on physically separated servers instead of managing their development, quality control and production environments on a single installation. In such cases, API Proxies can be exported to move API Proxy settings prepared in one environment to other environments or backup the configurations. In order to import the exported API Proxies, click the Import API Proxies link in the API Proxy List interface.


Clicking the link opens the API Proxy Import Wizard.


The exported file is uploaded and the import process is completed.

Downloading the API Proxy List as an Excel File

API Proxies displayed in the interface can be downloaded as an Excel file, containing only the filtered elements if a filter is available. For this, it is sufficient to click on the Excel icon in the upper right corner of the interface.


Creating an API Proxy

To create a new API Proxy, click the +Proxy button in the upper right corner of the interface. For creation details, you can refer to the Creating an API Proxy page.

Redeploying All API Proxies

All API Proxies installed or pending reinstallation can be reinstalled with one click. To do this, click on the icon in the header area of the rightmost column of the list.


API Proxy Operations

Bir API Proxy kaydının satırındaki menüde aşağıdaki işlemler seçilebilir.

Opening an API Proxy to update

Edit option opens the update and configuration interface for that API Proxy.

The same interface can be accessed clicking the name of that API Proxy record.

Deleting an API Proxy

Clicking on the Delete option opens a confirmation window to delete the API Proxy.

Reparsing an API Proxy

An API Proxy can be created by specifying the URL or an API definition file, uploading the definition file, or selecting an API Spec prepared on Apinizer. Changes made after API Proxy is created in these resources (for example adding a new method/endpoint, deleting an existing one, changing address) are not known by API Proxy. In order for these changes to be known to API Proxy, either manually updating the API Proxy or the Reparse option can be used.

When an API Proxy is reparsed, the existing name, description, and method/endpoints are compared and the changes are displayed.

If the Apply New API button is clicked, the settings on the original API Proxy are moved over the new API Proxy to be created by reparsing, and the newly created API Proxy replaces the original one.

Differences on the basis of parameters are not displayed on the screen during parsing. Differences in parameter or definition file are applied to API Proxy when Apply New API button is clicked.

Cloning an API Proxy 

It is possible to clone an API Proxy. Thus, a new API Proxy is created that has the same settings of the cloned API Proxy. Cloning is very convenient for purposes such as creating versions or opening the same API to different clients, over different addresses, and perhaps with slightly different settings. To clone an API Proxy, click the Duplicate option in the popup menu of the API Proxy record.

For the new API Proxy to be created by duplication, the user is prompted to enter a new name and a new gateway address.