Routing Websocket based APIs

As an API developer using Zowe, you can route WebSocket APIs through the API Mediation Layer. For details about Websocket routing from the client side, see Routing with websockets.

Required roles: Zowe extender, application developer

To accept Websockets, it is necessary that the API Mediation Layer is aware that a Websocket connection is required. To inform the API Mediation Layer, the issuer of the call to the API needs to add the (/ws/...) prefix in the URL of the called API.

Example of a valid URL for a Websocket API:

https://gatewayUrl/exampleService/ws/v1/communicate

Configure the service for Websockets

The configuration relevant for Websockets is contained within the routes section in the configuration. A complete example using a WebSocket that is statically onboarded is available in the API ML repo.

Example:

services:
    - serviceId: staticclient2
      routes:
        - gatewayUrl: ws/v1
          serviceRelativeUrl: /ws

• ws
  Specifies a WebSocket connection as presented in the beginning of the Gateway URL.

note

The serviceRelativeUrl is customizable and does not have to contain ws.

Example:
It is possible to access via the URL https://gatewayUrl/exampleService/ws/v1/communicate on the actual server that would appear as the URL https://serverUrl/exampleService/ui/communicate.