Megjegyzés
Az oldalhoz való hozzáféréshez engedély szükséges. Megpróbálhat bejelentkezni vagy módosítani a címtárat.
Az oldalhoz való hozzáféréshez engedély szükséges. Megpróbálhatja módosítani a címtárat.
Szabályzatok halmaza szabályozza a Data API Buildert a kompatibilitástörő változásokhoz, értesítésekhez, kiadásokhoz és verziószámozáshoz kapcsolódóan.
Verziószámozás és kiadások
A release in the context of Data API builder refers to every published version of the software, identified by the Major.Minor.Patch format. These releases fall into three categories: stable, breaking change, and preview.
Tárolófrissítési felelősség
A Data API Builder-tároló nem frissül automatikusan. Az ügyfelek feladata az új kiadások monitorozása, fontosságuk értékelése (beleértve a biztonsági frissítéseket is), valamint az üzembe helyezett tárolók megfelelő frissítése.
Keeping the container up to date is the customer’s responsibility.
Stable releases
A stable version of Data API builder is backwards compatible. A visszamenőleges kompatibilitás azt jelenti, hogy a Data API builder egy verziójára támaszkodó összes kód egy újabb, stabilabb verziót alkalmazhat anélkül, hogy kódmódosításokat kellene végrehajtania a helyesség vagy a meglévő funkciók fenntartása érdekében.
Kompatibilitástörő változáskiadások
A Data API Builder kompatibilitástörő változásverziója nem kompatibilis visszafelé. A meglévő ügyfélkódban a kompatibilitástörő változás verziójának bevezetése kódmódosítást igényelhet annak biztosításához, hogy az ügyfél pontosan ugyanúgy viselkedjen, mint az előző verzió megcélzásakor.
A kompatibilitástörő változásverziókat a kompatibilitástörő változáslistáról szóló cikkben és a GitHub-kiadás változásleírásában jelentik be. Az előzetes verzióra/kiadásra jelölt verzió közzététele megelőzi a kompatibilitástörő változásverziókat, kivéve, ha a módosítások kijavítják a kritikus biztonsági, adatvédelmi vagy jogi problémákat. Bár a Data API Builder korábbi verziói továbbra is elérhetők maradhatnak a GitHub kiadási oldalán, javasoljuk, hogy frissítsen a legújabb kiadásra, amely hibajavításokat is tartalmazhat.
Preview releases
A Data API Builder előzetes kiadásait a verziószámozási X.Y.Z-rc séma azonosítja. Az -rc utótag azt jelzi, hogy a build egy "kiadási jelölt". Az előzetes kiadásokkal visszajelzéseket gyűjthet az új funkciókról és egyéb változásokról.
Hacsak nem tervezzük, hogy szándékosan jelentős módosításokat hajtunk végre az utolsó stabil verzióról, közzétesszük a következő előzetes verziót a legújabb stabil kiadás és az új előzetes verzió funkcióival. A Data API builder következő frissítése megszakíthatja az előzetes verziók között hozzáadott új előzetes verziójú funkciók némelyikét. Ez a kompatibilitástörő viselkedés azt jelenti, hogy szükség lehet a kód módosítására, hogy a dolgok újra működjenek.
Az előzetes verziók nem hosszú távú vagy éles használatra szolgálnak. Ha egy új stabil vagy előzetes verzió elérhetővé válik, előfordulhat, hogy a régebbi előzetes verziók már nem lesznek elérhetők. A legjobb, ha csak akkor használja az előzetes verziókat, ha aktívan dolgozik az új funkciókon, és készen áll arra, hogy nem előzetes verzióra váltson a kiadás után. Ha az előzetes verzió egyes funkcióit egy új stabil verzió tartalmazza, a többi előzetes verziót hozzáadjuk egy új előzetes verzióhoz, hogy kipróbálhassa.
Verzióváltoztatási táblázat
Important
Ha a módosítás kritikus termékhibákat, jogi, biztonsági vagy adatvédelmi problémákat kezel, előfordulhat, hogy egy kisebb vagy egy javítás kiadásának kompatibilitástörő változását vezetjük be.
| Release type | Previous Version | New Version | Notes |
|---|---|---|---|
| Breaking Change | 1.Y.Z |
2.Y.Z |
Új funkciók és hibajavítások, valamint a kompatibilitástörő változások. |
| Stable | 1.1.Z |
1.2.Z |
Új funkciók és hibajavítások kompatibilitástörő változások nélkül, kivéve, ha a módosítások kritikus termékhibákkal, jogi, biztonsági vagy adatvédelmi problémákkal foglalkoznak. |
| Stable | 1.1.1 |
1.1.2 |
Hibajavítások új funkciók vagy kompatibilitástörő változások nélkül, kivéve, ha a módosítások kritikus termékhibákat, jogi, biztonsági vagy adatvédelmi problémákat kezelnek. |
| Preview | X.Y.1-rc |
X.Y.2-rc |
Új előzetes verziójú funkciók és hibajavítások. (A kompatibilitástörő változások akkor jelennek meg, ha a főverzió ütközik.) |
Breaking Changes
A biztonság rangsorolása, a funkciók javítása és a kódminőség fenntartása érdekében szoftverünk új verziói kompatibilitástörő változásokat is tartalmazhatnak. Bár igyekszünk minimalizálni ezeket a változásokat gondos architektúraválasztással, mégis előfordulhatnak. Ilyen esetekben prioritásként kezeljük a bejelentést és a lehetséges megoldásokat.
Important
Előfordulhat, hogy előzetes értesítés nélkül módosítjuk a módosítást, ha a módosítás nem minősül kompatibilitástörőnek, vagy ha a kritikus termékhibák, illetve a jogi, biztonsági vagy adatvédelmi problémák elhárítása érdekében végzett kompatibilitástörő változásról van szó.
Mi az a kompatibilitástörő változás?
A kompatibilitástörő változás olyan módosítás, amely megköveteli az alkalmazás frissítését a fennakadások elkerülése érdekében. A Data API Builderben a kompatibilitástörő változások közé tartozhatnak a REST API-szerződések módosítása, a GraphQL-séma létrehozása és a kompatibilitást és a funkcionalitást befolyásoló egyéb elemek.
Kompatibilitástörő változási példák
The following examples are a nonexhaustive list of breaking changes to Data API builder:
- REST API-szerződés módosítása
- Változások a GraphQL-sémagenerálásban
- A visszamenőleges kompatibilitást befolyásoló módosítások
- API-k vagy paraméterek eltávolítása vagy átnevezése
- Hibakódok változásai
- Az engedélydefiníció funkcióinak módosítása
- Az engedélyezett paraméterek, kérelemmezők vagy válaszmezők eltávolítása
- Kötelező paraméterek vagy kérésmezők hozzáadása alapértelmezett értékek nélkül
- A tervezett API-végpont funkcióinak módosítása
Nem törhető változás definíciója
A non-breaking change refers to a change that can be integrated into your application without causing disruption. A nem törhető módosításokat általában a végrehajtás után közlik. Az alkalmazást úgy kell megtervezni, hogy előzetes értesítés nélkül kezelje ezeket a módosításokat.
Nem kompatibilitástörő változási példák
The following examples are a nonexhaustive list of nonbreaking changes to Data API builder:
- Új végpontok bemutatása
- Metódusok hozzáadása meglévő végpontokhoz
- Új mezők beépítése válaszokba és kérelmekbe
- A mezők sorrendjének módosítása a válaszokban
- Az opcionális kérelemfejlécek bemutatása
- Az adathossz és a válasz méretének módosítása
- A hibaüzenetek és kódok módosítása
- A HTTP-válaszkódok javításai
- További metaadatok a létrehozott OpenAPI-dokumentumokban
Hogyan kommunikálhatunk a kompatibilitástörő változásokról?
Prioritásként kezeljük, hogy azonnal tájékoztassuk a kompatibilitástörő változásokról. A kompatibilitástörő változásértesítéseket a Data API Builder GitHubon elérhető kiadásainak kibocsátási megjegyzéseiben találja.
Aktuális kompatibilitástörő változáslista
Ebben a cikkben ismertetjük a kompatibilitástörő változásokat és a funkciók kivonását.
- Jelenleg nincsenek kompatibilitástörő változások