docs: improve limit-req plugin docs
#11873
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dosubot
bot
added
size:XL
juzhiyuan
approved these changes
Mar 4, 2025
Yilialinn
reviewed
Mar 5, 2025
| ``` | ||
|
|
||
| For authenticated requests: | ||
| Create `key-auth` Credential for the consumer: |
There was a problem hiding this comment.
Suggested change
| Create `key-auth` Credential for the consumer: | |
| Create `key-auth` Credential for the Consumer: |
| ``` | ||
|
|
||
| You can set a custom rejected message by configuring the `rejected_msg` attribute. You will then receive a response like: | ||
| Create `key-auth` Credential for the consumer: |
There was a problem hiding this comment.
Suggested change
| Create `key-auth` Credential for the consumer: | |
| Create `key-auth` Credential for the Consumer: |
| ``` | ||
|
|
||
| Similarly for removing the Plugin from a Consumer: | ||
| Send two requests simultaneously, each for one consumer: |
There was a problem hiding this comment.
Suggested change
| Send two requests simultaneously, each for one consumer: | |
| Send two requests simultaneously, each for one Consumer: |
| ``` | ||
|
|
||
| You should receive `HTTP/1.1 200 OK` for both requests, indicating the request has not exceeded the threshold for each consumer. |
There was a problem hiding this comment.
Suggested change
| You should receive `HTTP/1.1 200 OK` for both requests, indicating the request has not exceeded the threshold for each consumer. | |
| You should receive `HTTP/1.1 200 OK` for both requests, indicating the request has not exceeded the threshold for each Consumer. |
| ## Delete Plugin | ||
|
|
||
| To remove the `limit-req` Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect. | ||
| Create a Route with `key-auth` and `limit-req` plugins, and specify in the `limit-req` Plugin to use a combination of variables as the rate limiting key: |
There was a problem hiding this comment.
Suggested change
| Create a Route with `key-auth` and `limit-req` plugins, and specify in the `limit-req` Plugin to use a combination of variables as the rate limiting key: | |
| Create a Route with `key-auth` and `limit-req` Plugins, and specify in the `limit-req` Plugin to use a combination of variables as the rate-limiting key: |
| You can also configure the Plugin on specific consumers to limit their requests. | ||
|
|
||
| First, you can create a Consumer and enable the `limit-req` Plugin on it: | ||
| Generate three requests to the route: |
There was a problem hiding this comment.
Suggested change
| Generate three requests to the route: | |
| Generate three requests to the Route: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Improve
limit-reqplugin docs.Checklist