...
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
What is the API Gateway?
The PIPEFORCE API Gateway allows you to expose a RESTful API endpoint to the outside world. Once this external endpoint is called, this request can either be forwarded to an internal automation pipeline, a microservice running within PIPEFORCE, or simply to put a new message on a queue for to inform multiple listeners to respond toat the same time about the request.
Furthermore, on the API Gateway endpoint you can additionally configure, add authorization, filtering, logging or simply mock the endpoint until the real implementation is ready:
| Drawio | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
| Info |
|---|
You can also access request headers, parameters and body from inside your pipeline called by the API Gateway. For more details see: Pipeline Objects |
Service
This target forwards any request to a microservice deployed inside the cluster and managed by PIPEFORCE. Its mandatory to define the name of this service, the port and the service path to forward the request to.
...