Search Results

What is an Endpoint?

The REST API is exposed through an endpoint. It is the access point of a resource which a REST service exposes and a REST reference invokes. An endpoint uses the REST operations to provide access to the resource. An endpoint has a name and is represented by a path within the resource. It resides at a location specified by the URL of the resource.

Each endpoint in the TIBCO Cloud Integration web user interface represents a process.

The following scenarios use the PetStore sample to show you how the endpoints appear within an application in TIBCO Business Studio versus how they appear in the TIBCO Cloud Integration web user interface.

Scenario 1:

The PetStore application in this scenario has one process that uses one Swagger file with two paths and has a single resource. It has one HTTP shared resource which is configured with port 8081. This application, when viewed in the TIBCO Cloud Integration web user interface, will show a single endpoint.

Swagger file: petstore.json

Resource: PetStore

Paths:
  • /pet
  • /store

HTTP Shared Resource using port: 8081

Endpoint URL: https://<appID>/PetStore

Scenario 2:

This scenario has two processes and two paths. Both processes use the same Swagger file and the same HTTP shared resource which is configured with port 8081. This application, when viewed in the TIBCO Cloud Integration web user interface, will show two separate endpoints, one for each process. Both endpoints use the same port.

Swagger file: petstore.json

Resources:
  • Pet
  • Store
Paths:
  • /pet
  • /store

HTTP Shared Resource using port: 8081

Endpoint URLs:
  • https://<appID>/Pet
  • https://<appID>/Store

Scenario 3:

This scenario has two processes and two paths. Both processes use the same Swagger file but each has their own HTTP shared resource, one configured with port 8081 and the other with port 8082. This application, when viewed in the TIBCO Cloud Integration web user interface, will show two separate endpoints, one for each process, but each endpoint will use its own port.

Swagger file: petstore.json

Resources:
  • Pet
  • Store
Paths:
  • /pet
  • /store
HTTP Shared Resources:
  • port 8081
  • port 8082
Endpoint URLs:
  • https://<appID>/Pet
  • https://<appID>/Store