Skip to main content
Version: 1.0

APISIX

APISIX is a high-performance open-source API gateway designed for microservices and cloud-native applications. It offers dynamic routing, rate limiting, authentication, and traffic control features, ensuring efficient API management and scalability. APISIX is built on Nginx and Lua, providing flexibility and extensibility for modern development environments.

For basic usage, access the mentioned API endpoints via your API client. Authorization and authentication is done using Keycloak. The created Bearer token has to be forwarded to APISIX as Authorization-Header.

Dashboard

For having a look on the currently provided endpoints in the API Management you can use the APISIX Dashboard. This is currently not integrated via OIDC-Login, so the credentials from the inventory must be used.

APISIX Dashboard

Upstreams and Route Configuration

Default upstreams and respective routes for the platform services are pre-defined during deployment. These include FROST-Server, GeoServer, and Stellio.

APISIX Upstream List

Additional routes can be added per upstream.

APISIX Configure Route

Authorization for API Routes using the OIDC Plugin

For each route, the required scopes are defined in the OIDC plugin. Three specific OIDC scopes are defined in Keycloak by default:

  • apiwrite
  • apiread
  • apidelete

These scopes must be specified within the required_scopes array in the OIDC plugin editor:

APISIX Configure Plugin

Tokens are requested with a specific scope. APISIX will respect the requested scope when using the respective route.