API-k szabályozása a Visual Studio Code Azure API Center-bővítményével
Az API-szabályozási erőfeszítések sikerének maximalizálása érdekében kritikus fontosságú, hogy az API fejlesztési ciklusának korai szakaszában a bal oldali irányításra váltsunk. Ez a megközelítés lehetővé teszi az API-fejlesztők számára, hogy az elejétől kezdve helyesen hozzanak létre API-kat, így megtakaríthatják őket a felesleges fejlesztési erőfeszítésektől, és enyhítik a nem megfelelő API-kat a fejlesztési folyamat későbbi részében.
A Visual Studio Code Azure API Center bővítménye az alábbi szabályozási képességeket tartalmazza az API-fejlesztők számára:
- Api-tervek kiértékelése API-stíluskalauzok alapján, mivel az API-t a Visual Studio Code-ban fejlesztették ki.
- A kompatibilitástörő változások korai felismerése, hogy az API-k megbízhatóak és a várt módon működjenek, megőrizve a végfelhasználók és az érdekelt felek bizalmát.
Az API-fejlesztők a bővítmény funkcióit is kihasználva regisztrálhatják az API-kat az API-központban, és felfedezhetik és felhasználhatják az API-kat.
Előfeltételek
Egy vagy több API-központ az Azure-előfizetésben.
- Jelenleg hozzá kell rendelnie az Azure API Center szolgáltatás közreműködői szerepkörét vagy magasabb engedélyeit egy API-központhoz az API-k bővítménysel való kezeléséhez.
- Spektrális bővítmény a Visual Studio Code-hoz – shift-left API tervezési megfelelőség-ellenőrzések futtatása a Visual Studio Code-ban
- Optic CLI – az API specifikációs dokumentumai közötti kompatibilitástörő változások észlelése
Bővítmény beállítása
Telepítse a Visual Studio Code Azure API Center bővítményét a Visual Studio Code Marketplace-ről. Telepítse az előfeltételek között felsorolt egyéb bővítményeket.
Feljegyzés
Ahol megjegyezzük, bizonyos funkciók csak az Azure API Center bővítmény kiadás előtti verziójában érhetők el. Amikor telepíti a bővítményt a Visual Studio Code Marketplace-ről, a kiadás előtti vagy a kiadás előtti verziót is telepítheti. Váltson a két verzió között bármikor a Bővítmények nézetben a Kezelés gomb helyi menüjének használatával.
A Visual Studio Code bal oldali tevékenységsávján válassza az API-központot.
Ha nincs bejelentkezve az Azure-fiókjába, válassza a Bejelentkezés az Azure-ba... lehetőséget, és kövesse az utasításokat a bejelentkezéshez. Válasszon ki egy Azure-előfizetést azzal az API-központtal (vagy API-központtal), amelyből meg szeretné tekinteni az API-kat. Adott előfizetésekre is szűrhet, ha sok megtekintési lehetőség közül választhat.
API-kialakítási megfelelőség
Annak érdekében, hogy az API-k létrehozása során a tervezési megfelelőség megfeleljen a szervezeti szabványoknak, a Visual Studio Code-hoz készült Azure API Center bővítmény integrált támogatást nyújt az API specifikációinak a Spectralnal való lintinghez.
- A Parancskatalógus megnyitásához használja a Ctrl+Shift+P billentyűparancsot. Írja be az Azure API Centert : Állítsa be az aktív API stíluskalauzt , és nyomja le az Enter billentyűt.
- Válassza ki a megadott alapértelmezett szabályok egyikét, vagy ha a szervezet már rendelkezik stíluskalauzsal, használja a Helyi fájl kiválasztása vagy a Távoli bemenet URL-cím kiválasztása lehetőséget az aktív szabálykészlet megadásához a Visual Studio Code-ban. Nyomja le az Enter billentyűt.
Ha egy aktív API-stíluskalauz be van állítva, bármely OpenAPI- vagy AsyncAPI-alapú specifikációs fájl megnyitása helyi linting műveletet indít el a Visual Studio Code-ban. Az eredmények beágyazottan is megjelennek a szerkesztőben és a Problémák ablakban (Problémák megtekintése>vagy Ctrl+Shift+M).
Kompatibilitástörő változásészlelés
Az API új verzióinak bevezetésekor fontos gondoskodni arról, hogy a bevezetett módosítások ne szegik meg az API korábbi verzióiban az API-felhasználókat. A Visual Studio Code-hoz készült Azure API Center-bővítmény megkönnyíti az Optika által működtetett OpenAPI-specifikációs dokumentumok kompatibilitástörő változásészlelését.
- A Parancskatalógus megnyitásához használja a Ctrl+Shift+P billentyűparancsot. Írja be az Azure API Centert : Észleli a kompatibilitástörő változást , és nyomja le az Enter billentyűt.
- Válassza ki az első összehasonlítandó API-specifikációs dokumentumot. Az érvényes beállítások közé tartoznak az API-központban található API-specifikációk, egy helyi fájl vagy a Visual Studio Code aktív szerkesztője.
- Válassza ki a második, összehasonlítandó API-specifikációs dokumentumot. Az érvényes beállítások közé tartoznak az API-központban található API-specifikációk, egy helyi fájl vagy a Visual Studio Code aktív szerkesztője.
A Visual Studio Code megnyitja a két API-specifikáció közötti különbségnézetet. A kompatibilitástörő változások a szerkesztőben és a Problémák ablakban (Problémák megtekintése>vagy Ctrl+Shift+M) is megjelennek.
