Installing API Gateway Explorer

Overview

API Gateway Explorer is a graphical tool that enables you to test API functionality, performance, and security. For more details on API Gateway components and concepts, see the API Gateway Concepts Guide. This topic describes how to install API Gateway Explorer on the following platforms:

  • Windows

  • Linux

  • Solaris

Prerequisites

You must ensure the following:

System Requirements

See the System Requirements to ensure that the target machine is of a suitable specification.

Executable Permission

On Linux/UNIX, you must ensure that the installation executable has the appropriate permissions in your environment. For example, you can use the chmod command to update the file permissions.

Patching API Gateway Explorer 11.1.2.2.0

To patch your existing API Gateway Explorer installation, perform the following steps:

  1. Back up your existing API Gateway 11.1.2.2.0 installation.

  2. Delete your existing API Gateway Explorer installation directory (for example, INSTALL_DIR\apigatewayexplorer).

  3. Use the API Gateway 11.1.2.2.0 installation executable to install API Gateway Explorer into the same directory.

Installing API Gateway Explorer 11.1.2.2.0

Use the API Gateway 11.1.2.2.0 installation executable to install a new installation. When you run the executable in default GUI mode, you are presented with an introductory welcome screen. Click Next to continue with the installation.

For details on installing on the command line, see the section called “Unattended Installation”.

Installation Location

Enter or click Browse to specify the directory where you wish to install API Gateway components, for example:

Windows C:\OAG-11.1.2.2.0
Linux/UNIX /opt/OAG-11.1.2.2.0


Click Next to continue.

Select Components

Ensure that the API Gateway Explorer component is selected in the list, and click Next to continue.

[Note] Note

This topic describes how to install the API Gateway Explorer component only. For details on installing other components, see the following topics:

Ready to Install

The installer is ready to start installing the selected components and settings on your system.

Click Next to continue.

Installing

A progress screen is displayed showing the progress of the installation. Please wait for the installation to complete.

Click Next to continue.

Completing the API Gateway Explorer Setup

When the installer has finished installing the selected components, click Finish to complete the installation.

Ensure the API Gateway is Running

Before starting API Gateway Explorer, you should ensure that the Admin Node Manager and the API Gateway instance that you wish to test are running. For more details, see the topic on Installing the API Gateway Core Server.

For more details on API Gateway Explorer, see the API Gateway Explorer, User Guide.

Starting API Gateway Explorer

To launch API Gateway Explorer after installation, perform the following steps:

  1. Open a command prompt.

  2. Change to your API Gateway Explorer installation directory (for example, INSTALL_DIR\apigatewayexplorer).

  3. Start apigatewayexplorer.

Unattended Installation

You can run the API Gateway installer in unattended mode on the command line. The following command shows an example of installing the API Gateway Explorer component only:

Windows

OAG-11.1.2.2.0-windows-installer.exe --mode unattended 
   --enable-components apigatewayexplorer 
   --disable-components analytics,nodemanager,policystudio,configurationstudio,apimgmt

Linux

./OAG-11.1.2.2.0-linux-installer.run --mode unattended 
   --enable-components apigatewayexplorer 
   --disable-components analytics,nodemanager,policystudio,configurationstudio,apimgmt

The specified components are installed in the background.

Further Information

For a description of all available command options and default settings, enter the --help option. This outputs the help text in a separate console.