API-k felfedezése és felhasználása a Visual Studio Code Azure API Center-bővítményével
A szervezet API-fejlesztői a Visual Studio Code Azure API Center bővítményével fedezhetik fel és használhatják az API-k api-jait az API-központban . A bővítmény a következő funkciókat biztosítja:
API-k felfedezése – Tallózás az API-központban található API-k között, és megtekintheti azok részleteit és dokumentációját.
API-k használata – API SDK-ügyfelek létrehozása a kedvenc nyelvükön, például JavaScript, TypeScript, .NET, Python és Java nyelven, a Microsoft Graphhoz, a GitHubhoz és sok máshoz SDK-kat létrehozó Microsoft Kiota motor használatával.
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 biztosíthatják az API-szabályozást.
Tipp.
Ha azt szeretné, hogy a vállalati alkalmazásfejlesztők központosított helyen fedezzék fel az API-kat, opcionálisan engedélyezze a platform API-katalógusát a Visual Studio Code API-központjához. A platform API-katalógusa az API-leltár írásvédett nézete.
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.
- REST-ügyfélbővítmény – HTTP-kérések küldése és a válaszok megtekintése közvetlenül a Visual Studio Code-ban
- Microsoft Kiota-bővítmény – API-ügyfelek létrehozása
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-k felfedezése
Az API-központ erőforrásai a bal oldali fanézetben jelennek meg. Az API-központ erőforrásainak kibontásával megtekintheti az API-kat, a verziókat, a definíciókat, a környezeteket és az üzembe helyezéseket.
API-k keresése egy API-központban az Apis fanézetelemben látható keresési ikonnal.
API-dokumentáció megtekintése
Megtekintheti egy API-definíció dokumentációját az API-központban, és kipróbálhatja az API-műveleteket. Ez a funkció csak openAPI-alapú API-khoz érhető el az API-központban.
Az API-definíció megjelenítéséhez bontsa ki az API Center fanézetét.
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.
Az API kipróbálásához válasszon ki egy végpontot, válassza a Kipróbálás lehetőséget, adja meg a szükséges paramétereket, és válassza a Végrehajtás lehetőséget.
Feljegyzés
Az API-tól függően előfordulhat, hogy meg kell adnia az engedélyezési hitelesítő adatokat vagy egy API-kulcsot az API kipróbálásához.
Tipp.
A bővítmény előzetes verziójával létrehozhat api-dokumentációt a Markdownban, amely könnyen karbantartható és megosztható a végfelhasználókkal. Kattintson a jobb gombbal a definícióra, és válassza a Markdown létrehozása lehetőséget.
HTTP-fájl létrehozása
A fájlokat .http az API-központ API-definíciója alapján tekintheti meg. Ha a REST-ügyfél bővítmény telepítve van, a Visual Studio Code-szerkesztőből is létrehozhat kérések könyvtárat. Ez a funkció csak openAPI-alapú API-khoz érhető el az API-központban.
Az API-definíció megjelenítéséhez bontsa ki az API Center fanézetét.
Kattintson a jobb gombbal a definícióra, és válassza a HTTP-fájl létrehozása lehetőséget. Megjelenik egy új lap, amely megjeleníti az API-specifikáció által kitöltött .http-dokumentumot.
Ha kérést szeretne küldeni, válasszon ki egy végpontot, és válassza a Kérés küldése lehetőséget.
Feljegyzés
Az API-tól függően előfordulhat, hogy meg kell adnia az engedélyezési hitelesítő adatokat vagy egy API-kulcsot a kérés elvégzéséhez.
API-ügyfél létrehozása
A Microsoft Kiota bővítmény használatával hozzon létre egy API-ügyfelet a kedvenc nyelvéhez. Ez a funkció csak openAPI-alapú API-khoz érhető el az API-központban.
- Az API-definíció megjelenítéséhez bontsa ki az API Center fanézetét.
- Kattintson a jobb gombbal a definícióra, és válassza az API-ügyfél létrehozása lehetőséget. Megjelenik a Kiota OpenAPI Generator panel.
- Válassza ki az SDK-kba felvenni kívánt API-végpontokat és HTTP-műveleteket.
- Válassza az API-ügyfél létrehozása lehetőséget.
Adja meg az SDK nevével, névterével és kimeneti könyvtárával kapcsolatos konfigurációs adatokat.
Válassza ki a létrehozott SDK nyelvét.
Az ügyfél létre lesz hozva.
A Kiota bővítmény használatáról további információt a Visual Studio Code Microsoft Kiota bővítményében talál.
API-specifikáció exportálása
Exportálhat egy API-specifikációt egy definícióból, majd letöltheti fájlként.
Specifikáció exportálása a bővítmény fanézetében:
Az API-definíció megjelenítéséhez bontsa ki az API Center fanézetét.
Kattintson a jobb gombbal a definícióra, és válassza az API specifikációs dokumentum exportálása lehetőséget. Megjelenik egy új lap, amely egy API-specifikációs dokumentumot jelenít meg.
A parancskatalógus használatával is exportálhat specifikációt:
- Írja be a Ctrl+Shift+P billentyűparancsot a parancskatalógus megnyitásához.
- Válassza az Azure API Center: API specifikációs dokumentum exportálása lehetőséget.
- Válasszon egy API-definícióhoz való navigáláshoz. Megjelenik egy új lap, amely egy API-specifikációs dokumentumot jelenít meg.