Remote Server connection

Inspect activities in apiUiServer running remotely

apiUiServer is often working in a cloud environment. To be able to set information there or to get information from there, apiUiServer has its own API.
With apiUi running on your local machine, you can set up a connection with apiUiServer running remotely and than use that API from apiUi. This will e.g. enable you to inspect request/response pairs in apiUiServer in the same way as if these service-requests were sent to apiUi directly.

Set-up the remote server connection

Get there by Project->Set remote server connection (Alt+Shift+Cntrl+C).
Set Enabled to true and fill in the connection details.
You can then use the TestConnection button to check if the connection works. If not, check connection details and firewalls settings.

Standard remote server functions

From the GUI of apiUi there are some functions available that work directly via the remote server connection.

About remote server

Choose Help->About remote server to obtain version information from apiUiServer.

Inspecting the log from the remote server

Click on the Log messages from remote server button.

Download snapshots from the remote server

Click on the Download snapshots button.

Information from remote server

Choose Project->Information from remote server to get there.
apiUi will fetch project information from the remote server instance and display it on the screen.
Among these details is the projects version information.

Push project to remote server

Choose Project->Push project to remote server.
The project as it is in apiUi will be sent to the remote instance. If necessary, referenced files (OpenApi, Wsdl, Xsd) will be sent first.
After receiving a new design, the remote instance will become unavaillable for a short while, returning 503 http responsecodes.
This function is disabled by default. Enable it by checking allowedActions.pushDesign in the set-up for the remote server connection.

Push operation to remote server

Choose Push operation to remote server from the Operation context menu.
The selected operation as it is in apiUi will be sent to the remote instance along with the request/response mappings that belong to it. If necessary, referenced files (OpenApi, Wsdl, Xsd) will first be sent.
After receiving a new operation design, the remote instance will become unavailable for a short while, returning 503 http response-codes.
This function is disabled by default. Enable it by checking allowedActions.pushDesign in the set-up for the remote server connection.

Edit remote server environment variables

Choose Environment->Edit... (remote server) to view and optional alter environment variables from the remote server instance.

Reset remote state machine

Choose State machine->Reset (remote server) to reset the state machine in the remote server instance.

Connecting to WireMock

You can also set-up a connection with WireMock.
With WireMock as remote server, implemented functions are:

  1. Inspecting the log from WireMock.
    implemented by the WireMock API POST /__admin/requests/remove
    Enables you to produce the Coverage report, the Regression report, Test summary report and the Schema compliance report.
  2. Information from remote server (Project->Information from remote server)
    implemented by the WireMock API GET /__admin/mappings
  3. Push project to remote server.
    does execute the 'Push operation to remote server' for each Inbound operation.
  4. Push operation to remote server.
    Implemented by the WireMock API's POST /__admin/mappings/remove-by-metadata and POST /__admin/mappings.
    Disabled for Outbound operations.
  5. Reset remote state machine.
    implemented by the WireMock API POST /__admin/scenarios/reset