速率限制 REST API 与连接和 swagger

Question

I'm building a REST API using Flask and connexion. (Python)

I'm adding the api to the connexion app using a swagger.yml file that contains the definitions of all the endpoints, methods, etc...

The question is, how can I add a rate limit on a specific resource/route/call?

I can't seem to find it in the documentation.

Thanks.

Answer 1

You could use the X-Rate-Limit-* HTTP headers along with the http 429 status code.

This practically looks like in openapi:

  ....
  responses:
    "200":
      description: Success response
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/YourResponseModel"
      headers:
        "X-Rate-Limit-Limit": {
          "description": "The number of allowed requests in the current period",
          "schema": {
            "type": "integer"
          }
        } ,
        "X-Rate-Limit-Remaining": {
          "description": "The number of remaining requests in the current period",
          "schema": {
            "type": "integer"
          }
        },
        "X-Rate-Limit-Reset": {
         "description": "The number of seconds left in the current period",
         "schema": {
           "type": "integer"
         }
      }
    "429": 
      description: Too many requests
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorMessageResponse"

  ....

Answer 2

Connexion is a flask application so many techniques that work with flask work with connexion.

We successfully used Flask-Limter to do rate limiting.