← Babylon.js · projekttervezési csomag adatlapja

Skill · 1.0.0 verzió

API-kompatibilitás vizsgálata

Ellenőrzi, hogy a játékszerver API-jának változása elrontaná-e a telepített klienseket, a visszacsatlakozást vagy a várakozó kéréseket. Segít a meglévő kapcsolatokhoz illő átállást megtervezni.

api-compatibility-review

Ezt a skillt használó ügynökök

Nézd meg, miben segít

Mikor hasznos?

Akkor használd, amikor megváltozik egy végpont vagy közös interfész, de a régebbi klienseket is támogatnod kell.

Miben segít neked?

  • Feltárja a módosított mezők érintett hívóit, régebbi böngészőit és sorban álló üzeneteit.
  • Ellenőrzi a kötelező bemenetek, választípusok, alapértékek és lapozás visszafelé kompatibilitását.
  • Együtt vizsgálja a hibaválaszokat, az ismétlések védelmét és az elavult módosításokat.

Például ezt kérheted

Nézd át, hogyan cserélhetjük a meccseredmény winner mezőjét winners listára. Kövesd végig a régi klienst, a ranglistát frissítő feladatot és az eltárolt üzeneteket. A régebbi kliens továbbra is tudjon meccset befejezni; a régi mező törlése előtt ellenőrizd mindkét válaszformátumot.

Részletes dokumentáció

Itt a skill eredeti útmutatóját, példáit és ellenőrzési szempontjait olvashatod az eredeti nyelven.

Részletek…Összecsukás

API & Compatibility Review

Use this skill when reviewing changes that touch HTTP/REST/GraphQL/RPC endpoints, webhook/event payloads, CLI flags, configuration keys, or exported module signatures.

Workflow

  1. Inventory all consumers of the modified interface:
    • Search the entire monorepo or project (grep / symbol references) for every internal caller, UI client, SDK wrapper, background worker, and test fixture that consumes the changed interface.
    • Consider external or persisted consumers: saved webhooks, queued job payloads already in flight, browser tabs running slightly older frontend bundles, and external API clients.
  2. Check for breaking contract changes:
    • Request / Input contract:
      • Making an optional field required without a default value.
      • Narrowing accepted enum values, types, or validation bounds without migrating existing callers.
      • Renaming or removing query parameters, headers, or body properties.
    • Response / Output contract:
      • Removing, renaming, or changing the type/nullability of returned fields.
      • Changing pagination structure, sorting defaults, or error status codes/codes that clients branch on.
    • Configuration & environment defaults:
      • Changing a default config value in a way that alters production behavior when the env var is unset.
  3. Verify error contracts and idempotency:
    • Confirm that validation failures, missing resources, permission denials, and version conflicts return the project's standard structured error codes and HTTP statuses.
    • Verify that mutating endpoints preserve idempotency and concurrency guards (expectedVersion, Idempotency-Key).

Csomagban lévő fájlok 1

  • SKILL.md