Module plugins

Structs

AllowedByMethods

List of allowed configurations for Consumer settings, including a username of the Consumer and a list of allowed HTTP methods user - A username for a Consumer. methods - A list of allowed HTTP methods for a Consumer.

ConsumerRestriction

The consumer-restriction Plugin allows users to configure access restrictions on Consumer, Route, Service, or Consumer Group.

ConsumerRestrictionBuilder

Builder pattern to create a ConsumerRestriction

KeyAuth

The key-auth Plugin is used to add an authentication key (API key) to a Route or a Service. This works well with a Consumer. Consumers of the API can then add their key to the query string or the header to authenticate their requests. Documentation

KeyAuthBuilder

Builder pattern to create a KeyAuth

LimitCount

The limit-count Plugin limits the number of requests to your service by a given count per time. The plugin is using Fixed Window algorithm. Documentation

LimitCountBuilder

Builder to create a LimitCount

Plugins

Plugins that are executed during the request/response cycle.

ProxyRewrite

The proxy-rewrite Plugin rewrites Upstream proxy information such as scheme, uri and host. Documentation

ProxyRewriteBuilder

Builder pattern to create a ProxyRewrite

ProxyRewriteHeaders

[add]: Append the new headers. The format is {“name”: “value”,…}. The values in the header can contain Nginx variables like $remote_addr and $balancer_ip. It also supports referencing the match result of regex_uri as a variable like $1-$2-$3

Enums

AllowedMethodsType

List of allowed HTTP methods for a Consumer

ConsumerRestrictionType

Type of user specified key to use consumer_name - Username of the Consumer to restrict access to a Route or a Service consumer_group_id - ID of the Consumer Group to restrict access to a Route or a Service service_id - ID of the Service to restrict access from a Consumer. Need to be used with an Authentication Plugin route_id - ID of the Route to restrict access from a Consumer

LimitCountKeyType

Type of user specified key to use

LimitCountPolicy

Rate-limiting policies to use for retrieving and increment the limit count

ProxyRewriteMethod

Rewrites the HTTP method

Traits

Plugin