API-k elemzése az API-központban – Microsoft által felügyelt

A szervezet API-központja beépített, Microsoft által felügyelt linting képességeket (előzetes verzió) tartalmaz az API-definíciók elemzéséhez a szervezeti stílusszabályok betartásához, egyéni és összefoglaló jelentések készítéséhez. Az API-elemzés azonosítja és segít kijavítani az API-definíciókban előforduló gyakori hibákat és inkonzisztenciákat.

API-elemzéssel:

  • Az Azure API Center automatikusan elemzi az API-definíciókat, amikor hozzáad vagy frissít egy API-definíciót. Az API-definíciók szűrése alapértelmezés szerint egy spectral:oas szabálykészlettel (API-stíluskalauz) történik.
  • Az API-elemzési jelentések az Azure Portalon jönnek létre, amelyek bemutatják, hogyan felelnek meg az API-definíciók a stíluskalauznak.
  • Az elemzési profilokkal megadhatja az elemzett API-k szabálykészletét és szűrési feltételeit. A profil szabálykészletének testreszabása a Visual Studio Code Azure API Center bővítményével.

Fontos

Tetszés szerint engedélyezheti a saját felügyeletű lintinget és elemzést egy egyéni Azure-függvény használatával, felülírva a beépített képességeket. A felügyelt API-elemzés használata előtt tiltsa le az ön által felügyelt lintinghez használt függvényeket.

Korlátozások

  • Jelenleg csak az OpenAPI és az AsyncAPI specifikációs dokumentumai lesznek elemezve JSON vagy YAML formátumban.
  • Az elemzési profilok száma és az elemzett API-definíciók maximális száma korlátozott . Az elemzés végrehajtása eltarthat néhány percig vagy akár 24 óráig is.

Előfeltételek

API-elemzési jelentések megtekintése

Az Azure Portalon megtekintheti az API-definíciók elemzési összegzését és elemzési jelentéseit. Az API-definíciók elemzése után a jelentések a konfigurált API-stílus útmutatója alapján listáznak hibákat, figyelmeztetéseket és információkat.

Az API-elemzési jelentésben tekintse át az elemzéshez használt szabálykészletet és a linting passok előzményeit is.

Elemzési összegzés megtekintése az API-központban:

  1. A portálon keresse meg az API-központot.

  2. A bal oldali menü Irányítás területén válassza az API-elemzés lehetőséget. Megjelenik az összegzés.

    Képernyőkép az API-elemzés összegzéséről a portálon.

  3. Amennyiben szeretné, válassza az API-definícióhoz tartozó API-elemzési jelentés ikonját. Megjelenik a definíció API-elemzési jelentése az alábbi képernyőképen látható módon.

    Képernyőkép egy API-elemzési jelentésről a portálon.

    Tipp.

    Az API-elemzési jelentés megtekintéséhez válassza az Elemzés lehetőséget az API-definíció menüsávján.

Elemzési profilok kezelése

Azure API Center analízisprofilokat használ az API-k szöszítéséhez és elemzéséhez. Az elemzési profil egy szabálykészletet határoz meg, és opcionálisan szűri az elemzett API-k feltételeit. Az alapértelmezett elemzési profil minden OpenAPI- és AsyncAPI-definícióra alkalmazza a spectral:oas szabálykészletet.

Testre szabhatja a szabálykészletet, és megadhatja a szűrőfeltételeket az alapértelmezett profilban, vagy létrehozhat egy új profilt. Előfordulhat például, hogy egy profilt szeretne használni a fejlesztés alatt lévő API-khoz, és egy másikat az éles környezetben lévő API-khoz.

Megjegyzés:

Az API Center Standard csomagjában legfeljebb három elemzési profilt hozhat létre. Az ingyenes csomag csak egyetlen profilt támogat.

Elemzési profil létrehozása:

  1. Az Azure Portalon keresse meg az API-központot.
  2. A bal oldali menü Irányítás területén válassza az API AnalysisManage analysis profiles> (Elemzési >) lehetőséget.
  3. Az Új elemzési profil létrehozása panelen adja meg a profil nevét és leírását .
  4. A Szabálykészletben megjelenik a szabálykészlet elemzőtípusa (linting engine). Jelenleg csak a Spectral támogatott.
  5. A Szűrőfeltételek definiálása csoportban adjon hozzá egy vagy több szűrőfeltételeket a profil által alkalmazott API-definíciókhoz.
  6. Válassza a Létrehozása lehetőséget.

Képernyőkép egy elemzési profil létrehozásáról a portálon.

Elkészül a profil, és létrehozásra kerül egy szabálykészlet-váz. Az aktuális szabálykészlet megtekintéséhez válassza ki a profilt, majd a környezet (...) menüjében válassza a Szabálykészlet megtekintése lehetőséget.

A szabálykészlet testreszabásához folytassa a következő szakaszokkal.

A profil szabálykészletének testreszabása

A Azure API Center Visual Studio Code bővítményével testre szabhatja egy profil szabálykészletét. A szabálykészlet testreszabása és helyi tesztelése után újra üzembe helyezheti az API-központban.

  1. A Visual Studio Code-ban válassza az Azure API Center ikont a tevékenységsávon.
  2. Az API Center panelen bontsa ki a használatban lévő API-központ erőforrását, és bontsa ki a Profilok elemet.
  3. Bontsa ki a módosítani kívánt profilt, és válassza a lehetőséget ruleset.yaml.
  4. Szükség szerint módosítsa vagy cserélje le a tartalmat.
  5. Mentse a módosításokat a fájlba ruleset.yaml.

Szabálykészlet helyi tesztelése

Mielőtt üzembe helyezené az egyéni szabálykészletet az API-központban, ellenőrizze helyileg. 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ók Spektrálissal való lintinghez.

  1. A Visual Studio Code-ban a Ctrl+Shift+P billentyűparanccsal nyissa meg a parancskatalógust.

  2. Írja be az Azure API Centert : Állítsa be az aktív API stíluskalauzt , és nyomja le az Enter billentyűt.

  3. Válassza a Helyi fájl kiválasztása lehetőséget, és adja meg a ruleset.yaml testre szabott fájlt. Nyomja le az Enter billentyűt.

    Ez a lépés teszi az egyéni szabálykészletet a helyi linting aktív API-stílusának útmutatóvá.

Most, amikor megnyit egy OpenAPI-alapú API-definíciós fájlt, a rendszer automatikusan elindít egy helyi linting műveletet a Visual Studio Code-ban. Az eredmények közvetlenül jelennek meg a szerkesztőben és a Problémák ablakban (> vagy Ctrl+Shift+M).

Tipp.

A szervezet API-fejlesztői is használhatják ezt a helyi linting képességet az API-definíciók továbbfejlesztéséhez, mielőtt regisztrálják az API-kat az API-központban.

Képernyőkép egy API-definíció Visual Studio Code-ban való lintingéről.

Tekintse át a linting eredményeit. Végezze el a szükséges módosításokat a szabálykészleten, és folytassa a helyi tesztelést, amíg a kívánt módon nem hajtja végre.

Szabálykészlet üzembe helyezése az API-központban

Az egyéni szabálykészlet üzembe helyezése az API-központban:

  1. A Visual Studio Code-ban válassza az Azure API Center ikont a tevékenységsávon.
  2. Az API Center panelen bontsa ki azt az API-központ-erőforrást, amelyben testre szabta a szabálykészletet.
  3. Profilok bővítése.
  4. Kattintson a jobb gombbal arra a profilra, amelyben testre szabta a szabálykészletet, és válassza a Szabályok üzembe helyezése az API Centerben lehetőséget.

Egy üzenet értesíti Önt, miután a szabályok sikeresen üzembe lettek helyezve az API-központban. A linting motor a frissített szabálykészlet használatával elemzi a profil API-definícióit.

A frissített szabálykészlettel való linting eredményeinek megtekintéséhez tekintse meg az API-elemzési jelentéseket a portálon.

Kapcsolódó tartalom

  • Last updated on