Skip to main content

What is Plugin

Estimated reading time: 0 min read

In API7 Cloud, a plugin is a rule that defines how the data plane instance will handle the requests. By saying handled, it means requests might be:

  1. transformed (headers, query parameters, body);
  2. protected (authentication, authorization, rate-limiting, etc.);
  3. recorded (logging, metrics, etc.);

A plugin can be attached on a specific Application, API, Consumer, or Control Plane. The effective rules of the plugin are as follows:

  • Plugins attached to the API only work for this API and will override the same ones on the Application (instead of running them twice).
  • Plugins attached to the Application will affect all APIs in this Application.
  • Plugins attached to the Consumer only work for this Consumer and will override the same ones on the Application and API (instead of running them twice).
  • Plugins attached to the Control Plane will be effective for all API requests. Care must be taken that these plugins won't override the same ones on the Application, API, and Consumer, i.e. same plugins will be run twice (the one on Control Plane runs first).

What's Next

API7 Cloud provides several plugins for different purposes. Please refer to the table of contents below to learn the details.