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

Az Azure-hoz készült GitHub Copilot API Center beépülő modulja felgyorsítja az új API-k tervezését és fejlesztését a természetes nyelvi kérésektől kezdve. Az AI-támogatás az API Center beépülő modullal és a Visual Studio Code API Center bővítményével kombinálva érhető el. 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.

Előfeltételek

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

A bővítmény beállítása az alábbi lépések végrehajtásával:

  1. Telepítse a Visual Studio Code Azure API Center bővítményét a Visual Studio Code Marketplace-ről. Szükség szerint telepítsen más bővítményeket.

    Megjegyzés:

    A [PREVIEW] jelölés azt jelzi, hogy a funkciók csak az Azure API Center bővítmény előzetes verziójában érhetők el. Amikor telepíti a bővítményt a Visual Studio Code Marketplace-ről, kiválaszthatja, hogy telepíti a kiadási verziót vagy egy előzetes verziót (amint elérhető). A telepített verziók közötti váltáshoz válassza a bővítmény Kezelés gombját (fogaskerék ikon) a Visual Studio Code Bővítmények nézetében.

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

    Képernyőkép az API Center bővítmény ikonjáról a Visual Studio Code tevékenységsávjában.

  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.

  4. Válasszon ki egy Azure-előfizetést a megtekinteni kívánt API-kkal rendelkező API-központtal (vagy API-központokkal). Ha több fiókkal rendelkezik, adott előfizetésekre is szűrhet.

Kérés küldé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: Azure API Center: API Stílus Útmutató beállítása, válassza ki a megfelelő lehetőséget, és 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.

    Jótanács

    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 Visual Studio 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 Visual Studio Code-ban válassza ki a Regisztrálja API-ját az API-központban gombot a beszélgetési panelen, vagy válassza a Azure API-központ: API regisztrálása lehetőséget a Parancskatalógusból.

  2. Válassza a Manuális lehetőséget.

  3. Válassza ki azt az API-központot, amellyel API-kat szeretne regisztrálni.

  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 UI-jával.

A Swagger UI felület képernyőképe az Azure API Center kiterjesztésben a Visual Studio Code-hoz.

Kapcsolódó tartalom

  • Last updated on