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

API-k tervezése és fejlesztése az Azure-hoz készült GitHub Copilot API Center beépülő modullal

  • Cikk

Az Azure-hoz készült GitHub Copilot API Center beépülő modulja (előzetes verzió) természetes nyelvi kérésekből kiindulva felgyorsítja az új API-k tervezését és fejlesztését. Az API Center beépülő modul és az API Center VS Code bővítmény segítségével elérhető AI-támogatással egyszerűen írja le az API-t, és gyorsan hozzon létre egy OpenAPI-specifikációt az API-fejlesztéshez, amely megfelel a szervezet szabványainak. A megfelelő specifikáció létrehozása után regisztrálhatja az API-t az API-központban.

Feljegyzés

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

Előfeltételek

  • GitHub Copilot for Azure – OpenAPI-specifikációs fájlok létrehozása az Azure-hoz készült GitHub Copilot Azure API Center beépülő moduljának használatával (előzetes verzió)

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.

Kérés kérése az @azure ügynökhöz

Kövesse az alábbi lépéseket egy OpenAPI-specifikáció létrehozásához természetes nyelvi kérések használatával az Azure-hoz készült GitHub Copilottal:

  1. Ha szükséges, állítson be egy aktív API-stílus útmutatót az Azure API Center bővítményben. A Parancskatalógus megnyitásához használja a Ctrl+Shift+P billentyűparancsot. Írja be az Azure API Centert : Api Style Guide beállítása, kijelölés, majd nyomja le az Enter billentyűt.

    Ha nincs beállítva stíluskalauz, a rendszer az alapértelmezett spectral:oas szabálykészletet használja. További információ az API-specifikációk API Center-bővítmény használatával történő lintingről.

  2. A csevegőpanelen küldjön egy természetes nyelvű kérést az ügynöknek az @azure API-nak való leírásához. Példa:

    @azure Generate an OpenAPI spec: An API that allows customers to pay for an order using various payment methods such as cash, checks, credit cards, and debit cards. Check that there are no duplicate keys.

    A Copilot mesterséges intelligenciával működik, így meglepetések és hibák lehetségesek. További információkért lásd a Copilot gyakori kérdéseket.

    Az ügynök egy OpenAPI-specifikációs dokumentummal válaszol.

    Képernyőkép arról, hogyan hozhat létre OpenAPI-specifikációt @azure bővítmény használatával egy parancssorból.

  3. Tekintse át a létrehozott kimenetet az API-stílus útmutatójának pontosságáért, teljességéért és megfelelőségéért.

    Szükség esetén pontosítsa a kérést a specifikáció újragenerálásához, vagy ismételje meg a folyamatot az Azure API Center bővítményben beállított másik stíluskalauz használatával.

    Tipp.

    A hatékony kérések az API üzleti követelményeire összpontosítanak a megvalósítás részletei helyett. A rövidebb kérések néha jobban működnek, mint a hosszabbak.

  4. Ha megfelel a követelményeknek, mentse a létrehozott OpenAPI-specifikációt egy fájlba.

Az API regisztrálása az API-központban

A VS Code Azure API Center bővítményével regisztrálhatja az API-t az API-központban a létrehozott specifikációs fájlból. Az API regisztrálása után a bővítmény használatával megtekintheti az API dokumentációját, létrehozhat egy HTTP-ügyfelet, további lintinget és elemzést végezhet, és így tovább.

  1. A VS Code-ban válassza az API regisztrálása az API Centerben gombot a csevegőpanelen, vagy válassza az Azure API Center: Api regisztrálása parancskatalógusból.

  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ó (specifikáció) fájl az API-regisztráció befejezéséhez.

Az API regisztrálása után különböző feladatokat hajthat végre a bővítmény használatával. Tekintse meg például az API dokumentációját a Swagger felhasználói felületén:

  1. Bontsa ki az API Center fanézetét a regisztrált API-verzió definíciójának kiválasztásához.

  2. Kattintson a jobb gombbal a definícióra, és válassza az API-dokumentáció megnyitása parancsot. Megjelenik egy új lap az API-definíció Swagger felhasználói felületével.

Képernyőkép a VS Code bővítmény Swagger felhasználói felületéről.

Kapcsolódó tartalom