API

In APIIDA API Gateway Manager, we are using the term API as being a Managed Service. Think of API as some kind of enhanced Layer7 service. An API can consist of one or more Layer7 services and is augmented with additional metadata. This metadata allows the Gateway Manager to perform additional tasks of which the Layer7 gateway itself is not capable.

You can monitor the basic metrics of each API like the number of requests or frontend and backend response times. Depending on the environment different alarming thresholds can be defined that trigger warnings and alarms at given values. You might want to define a rule, that alarms your team via Slack whenever the frontend response time raises above 100ms in production. For more information on alarming please consult the corresponding section of this documentation.

Another capability of APIs is the use of a repository. These repositories act as the single point of truth for an API. APIIDA API Gateway Manager allows you to migrate a specific version stored in that repository to your gateways. You don’t need to manually import that version into some kind of integration gateway first. For more information on the possibilities of repository-based migrations or migrations in general please refer to the corresponding sections of this documentation.

https://apiida.atlassian.net/wiki/spaces/AAGM/pages/7654572033

Folder

Folders first correspond to the folders from the gateway. They group the APIs and create a logical unit. If you register entire folders in the Gateway Manager, you also register all the underlying services.

Instance

When a folder or service is registered, it is created in the Gateway Manager and the instance of it is created at the same time. The instance is the deployed version of the API running on a gateway. An API cannot occur twice, but there is one instance for each gateway on which the API is present.