Sebességkorlátozó Bővítmény

Sebességkorlát viselkedését szimulálja.

Parancssor képernyőképe a GitHub API-k sebességkorlátozását szimuláló Dev Proxyval.

Példa konfigurációra

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v4.0.0/rc.schema.json",
  "plugins": [
    {
      "name": "RateLimitingPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
      "configSection": "rateLimiting"
    }
  ],
  "rateLimiting": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v4.0.0/ratelimitingplugin.schema.json",
    "costPerRequest": 2,
    "rateLimit": 120
  }
}

Konfigurációs tulajdonságok

Ingatlan Leírás Alapértelmezett
headerLimit A sebességkorlátozó korlátot kommunikáló válaszfejléc neve RateLimit-Limit
headerRemaining Annak a válaszfejlécnek a neve, amely közli a fennmaradó számú erőforrást az alaphelyzetbe állítás előtt RateLimit-Remaining
headerReset Annak a válaszfejlécnek a neve, amely közli az alaphelyzetbe állításig hátralévő időt RateLimit-Reset
headerRetryAfter Annak a válaszfejlécnek a neve, amely közli az újrapróbálkozási időszakot Retry-After
costPerRequest Hány erőforrásba kerül egy kérelem? 2
resetTimeWindowSeconds Mennyi idő másodpercben a következő visszaállításig 60
warningThresholdPercent A túllépett használat százalékos aránya elindítja a válaszfejlécek sebességkorlátozását 80
rateLimit Egy időablak erőforrásainak száma Százhúsz
whenLimitExceeded Az a viselkedés, amelyet a beépülő modulnak használnia kell, ha túllépi a korlátot. Throttle vagy Customhasználata. Throttle
resetFormat A sebességkorlát alaphelyzetbe állításának időpontjának meghatározására használt formátum. SecondsLeft vagy UtcEpochSecondshasználata. SecondsLeft
customResponseFile A korlát túllépésekor használt egyéni hibaválaszt tartalmazó fájl. rate-limit-response.json

Parancssori beállítások

Egyik sem

Remarks

Egyéni válasz törzse

Ha az body egyéni válaszfájl tulajdonságát JSON-objektumra vagy tömbre állítja be, a Dev Proxy JSON-ra szerializálja azt. Ha sztringre állítja, a Dev Proxy a sztringet as-isküldi el, idézőjelek nélkül. Mivel a Dev Proxy alapértelmezés szerint a Content-Type fejlécet application/jsonállítja be, állítsa be a Content-Type fejlécet úgy, hogy megfeleljen a tartalomnak, amikor például text/plainnem JSON-tartalmat ad vissza.

Egyéni válaszfejléc Content-Type

Ha whenLimitExceeded be van állítva Custom , és az egyéni válasz tartalmaz egy body fejlécet, de nem határoz meg fejlécet Content-Type , a Dev Proxy a fejlécmel együtt adja vissza a Content-Type: application/json választ. Ha másik tartalomtípust szeretne visszaadni, adja hozzá a Content-Type fejlécet az egyéni válaszfájlhoz. A Dev Proxy a megadott értéket használja.

Következő lépés