Megosztás a következőn keresztül:

API-k létrehozása és regisztrálása a Visual Studio Code Azure API Center-bővítményével

  • Cikk

A szervezet API-gyártó fejlesztői api-kat hozhatnak létre és regisztrálhatnak az API-központ készletében a Visual Studio Code Azure API Center bővítményével. Az API-fejlesztők a következőkre képesek:

  • Adjon hozzá egy meglévő API-t egy API-központhoz egyszeri műveletként, vagy integráljon egy fejlesztési folyamatot az API-k CI/CD-munkafolyamat részeként történő regisztrálásához.
  • A GitHub Copilot használatával új OpenAPI-specifikációkat hozhat létre AZ API-kódból.

Az API fogyasztói fejlesztői a bővítmény funkcióit is kihasználhatják az API-központ API-k felderítéséhez és felhasználásához, valamint az API-szabályozás biztosításához.

Előfeltételek

A megadott forgatókönyvekhez a következő Visual Studio Code-bővítményekre van szükség:

  • GitHub Actions – API-k regisztrálása CI/CD-folyamattal a GitHub Actions használatával
  • Azure Pipelines – API-k regisztrálása CI/CD-folyamat használatával az Azure Pipelinesban
  • GitHub Copilot – OpenAPI specifikációs fájlok létrehozása API-kódból

Bővítmény beállítása

  1. 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.

  2. A Visual Studio Code bal oldali tevékenységsávján válassza az API-központot.

    Képernyőkép az API Center bővítményről a tevékenységsávon.

  3. 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 regisztrálása – lépésről lépésre

Az alábbi lépések egyszeri műveletként regisztrálnak egy API-t az API-központban.

  1. A Parancskatalógus megnyitásához használja a Ctrl+Shift+P billentyűparancsot. Írja be az Azure API Centert : Regisztrálja az API-t , és nyomja le az Enter billentyűt.
  2. Válassza a Manuális lehetőséget.
  3. Válassza ki az API-központot az API-k regisztrálásához.
  4. A válasz olyan információkat tartalmaz, mint az API-cím, a típus, a verziócím, a verzió életciklusa, a definíció címe, a specifikáció neve és a definíciófájl az API-regisztráció befejezéséhez.

Az API hozzá lesz adva az API-központ készletéhez.

API-k regisztrálása – CI/CD-folyamat

Az alábbi lépések egy API-t regisztrálnak az API-központban egy CI/CD-folyamattal. Ezzel a beállítással adjon hozzá egy előre konfigurált GitHub- vagy Azure DevOps-folyamatot az aktív Visual Studio Code-munkaterülethez, amely egy CI/CD-munkafolyamat részeként fut az egyes véglegesítéseken a forrásvezérléshez. Javasoljuk, hogy az API-központtal ci/CD használatával leltározza az API-kat, hogy az API metaadatai , beleértve a specifikációt és a verziót is, naprakészek maradjanak az API-központban, mivel az API folyamatosan fejlődik az idő múlásával.

  1. A Parancskatalógus megnyitásához használja a Ctrl+Shift+P billentyűparancsot. Írja be az Azure API Centert : Regisztrálja az API-t , és nyomja le az Enter billentyűt.
  2. Válassza a CI/CD lehetőséget.
  3. Válassza ki a GitHubot vagy az Azure DevOpsot az előnyben részesített forrásvezérlési mechanizmustól függően. Egy Visual Studio Code-munkaterületnek nyitva kell lennie ahhoz, hogy az Azure API Center-bővítmény hozzáadjon egy folyamatot a munkaterülethez. A fájl hozzáadása után végezze el a CI/CD-folyamatfájlban dokumentált lépéseket a szükséges környezeti változók és identitás konfigurálásához. A forráskövetésbe való leküldés során az API regisztrálva van az API-központban.

További információ egy GitHub Actions-munkafolyamat beállításáról az API-k API-k api-központban való regisztrálásához.

OpenAPI-specifikáció létrehozása API-kódból

A GitHub Copilot és a Visual Studio Code Azure API Center bővítményének használatával hozzon létre egy OpenAPI-specifikációs fájlt az API-kódból. Kattintson a jobb gombbal az API-kódra, válassza a Lehetőségek közül a Copilot lehetőséget, és válassza az API-dokumentáció létrehozása lehetőséget. A GitHub Copilot létrehoz egy OpenAPI specifikációs fájlt.

Feljegyzés

Ez a funkció az API Center bővítmény előzetes verziójában érhető el.

Animáció, amely bemutatja, hogyan hozhat létre OpenAPI-specifikációt kódból a GitHub Copilot használatával.

Az OpenAPI specifikációs fájl létrehozása és a pontosság ellenőrzése után regisztrálhatja az API-t az API-központban az Azure API Center: Register API paranccsal.

Tipp.

Az API-fejlesztők természetes nyelvi kérésekkel is létrehozhatnak új OpenAPI-specifikációkat az Azure-hoz készült GitHub Copilot API Center beépülő moduljával. További információ.

Kapcsolódó tartalom