Common Use Cases

The Ingress Controller allows you to configure all plugins supported by the underlying gateway, covering a wide range of common use cases such as AI integration, traffic management, request transformation, authentication, security, observability, and more.

• API7 Ingress Controller: supports configuring all plugins available in API7 Enterprise.
• APISIX Ingress Controller: supports configuring all plugins available in APISIX.

For users familiar with APISIX or API7 Enterprise plugins, the concepts remain the same. For those new to the ecosystem, it is recommended to explore the Plugin Hub (opens in Plugin Hub docs) to review the available plugins and develop a general understanding of their capabilities.

This document introduces common use cases, highlights the plugins you can apply, and offers an overview of how to configure them using the Ingress Controller.

How to Configure Plugins in AIC

This document provides an overview rather than full configuration details for each plugin. Refer to the examples below and the CRD documentation for common plugin configuration patterns:

• Configure a plugin on a route
• Configure a plugin on a consumer
• Configure a plugin in PluginConfig
• Configure a global plugin
• Configure plugin metadata

For detailed plugin parameters and usage, visit the Plugin Hub (opens in Plugin Hub docs).

Rate Limiting

Rate limiting is a commonly used technique for managing API traffic. You can configure your APIs to control the rate of requests or connections, ensuring fair usage and protecting against attacks such as DDoS or excessive crawler traffic.

There are several rate limiting plugins available that help you implement rate limiting:

• limit-count (opens in Plugin Hub docs) uses a fixed window algorithm, which sets limits on the number of requests within non-overlapping time intervals.
• limit-count-advanced (opens in Plugin Hub docs) builds on limit-count (opens in Plugin Hub docs) with additional features. It supports using a sliding window algorithm to enforce request limits over overlapping time intervals. This plugin is only available in API7 Enterprise.
• limit-req (opens in Plugin Hub docs) limits requests by the number of requests within a given time interval and a set capacity.
• limit-conn (opens in Plugin Hub docs) limits requests by the number of concurrent connections.
• graphql-limit-count (opens in Plugin Hub docs) limits requests by the depth of GraphQL operations or mutations within a given time interval. This plugin is only available in API7 Enterprise.

Authentication

Authentication is the process of verifying the identity of a client before granting access to an API. It ensures that only authorized users or applications can interact with your services, protecting sensitive data and preventing unauthorized access.

There are a number of authentication plugins available to help you secure your APIs:

• key-auth (opens in Plugin Hub docs) — verifies access using a simple API key.
• basic-auth (opens in Plugin Hub docs) — authenticates clients using a username and password.
• jwt-auth (opens in Plugin Hub docs) — validates JSON Web Tokens (JWT) for stateless authentication.
• hmac-auth (opens in Plugin Hub docs) — authenticates requests using HMAC signatures to ensure integrity and verify the client’s identity.
• and many more (opens in Plugin Hub docs).

Request & Response Transformation

Request and response transformation allows you to modify incoming requests before they are sent to upstream services, as well as alter responses before they reach the client. This can include rewriting paths, adding or removing headers, adjusting query parameters, or modifying the request or response body. Transformations help ensure that your APIs remain consistent and compatible with different client requirements or upstream service expectations.

There are several plugins available to help you implement transformation:

• proxy-rewrite (opens in Plugin Hub docs) — rewrites the request path, host, or headers.
• response-rewrite (opens in Plugin Hub docs) — modifies response status codes, headers, or bodies.
• mocking (opens in Plugin Hub docs) — simulates API responses without forwarding requests to upstream services.
• and many more (opens in Plugin Hub docs).

These plugins allow you to adapt requests and responses without modifying your upstream services, making API integration more flexible and easier to maintain.

AI Integration

AI integration enables your APIs to connect with AI services. This supports functionality such as text generation, summarization, embedding search, retrieval‑augmented generation (RAG), content moderation, and more.

There are several plugins available to support AI integration:

• ai-proxy (opens in Plugin Hub docs) — simplifies integration with LLM providers, such as OpenAI and DeepSeek.
• ai-rag (opens in Plugin Hub docs) — enables retrieval‑augmented generation to improve output relevance and accuracy.
• ai-aws-content-moderation (opens in Plugin Hub docs) / ai-aliyun-content-moderation (opens in Plugin Hub docs) — integrate with external content‑moderation services to scan prompts for toxicity, hate speech or disallowed content, rejecting requests that fail the moderation.
• ai-rate-limiting (opens in Plugin Hub docs) — enforces token‑based rate limiting on LLM requests, helping you control usage, prevent abuse, and manage cost or resource usage.
• and many more (opens in Plugin Hub docs).

Observability

Observability provides insight into the behavior, health, and performance of your API traffic. With proper observability, you can monitor, trace, and log requests to detect anomalies, troubleshoot issues, and improve reliability across your microservices.

There are a number of observability plugins available, covering logging, metrics, and tracing:

• prometheus (opens in Plugin Hub docs) — exposes gateway metrics to monitor performance.
• kafka-logger (opens in Plugin Hub docs) — pushes logs in batches to a Kafka cluster for scalable log handling and downstream processing.
• opentelemetry (opens in Plugin Hub docs) — instruments the gateway to generate traces according to the OpenTelemetry standard, allowing export to OTLP‑compatible collectors.
• zipkin (opens in Plugin Hub docs), skywalking (opens in Plugin Hub docs) — support sending trace data to compatible tracing backends for full-view request path tracing across services.
• and many more (opens in Plugin Hub docs).

Next Steps

Visit how-to guides for configuration scenarios that are not covered by built-in plugin functionality.