Oktatóanyag: Api-k importálása és kezelése a Visual Studio Code Azure API Management bővítményével

A következőkre vonatkozik: Felhasználás | Fejlesztő | Alapszintű | Standard | Prémium

Ebben az oktatóanyagban megtudhatja, hogyan használhatja a Visual Studio Code API Management bővítményét az API Management gyakori műveleteihez. Az ismerős Visual Studio Code-környezettel importálhatja, frissítheti, tesztelheti és kezelheti az API-kat.

Az alábbiak végrehajtásának módját ismerheti meg:

További API Management-funkciókról az Azure Portal API Management-oktatóanyagaiból tájékozódhat.

Előfeltételek

• Az Azure API Management terminológiája.
• Győződjön meg arról, hogy telepítette a Visual Studio Code-ot és a Visual Studio Code legújabb Azure API Management-bővítményét.
• Hozzon létre egy API Management-példányt.

API importálása

Az alábbi példa egy JSON formátumú OpenAPI-specifikációt importál az API Managementbe. Ebben a példában importálja a nyílt forráskód Petstore API-t.

1. A Visual Studio Code-ban válassza az Azure ikont a tevékenységsávon.
2. Az Explorer panelen bontsa ki a létrehozott API Management-példányt.
3. Kattintson a jobb gombbal az API-kra, és válassza az Importálás az OpenAPI-hivatkozásból lehetőséget.
4. Amikor a rendszer kéri, adja meg a következő értékeket:

   1. OpenAPI-hivatkozás JSON formátumú tartalomhoz. Ebben a példában: https://petstore.swagger.io/v2/swagger.json.

      Ez a fájl a példa API-t és az általa támogatott műveleteket implementáló háttérszolgáltatást adja meg.

   2. Az API Management-példányban egyedi API-név, például petstore. Ez a név csak betűket, számokat és kötőjeleket tartalmazhat. Az első és az utolsó karakternek alfanumerikusnak kell lennie. Ezt a nevet használja a rendszer az API meghívásának elérési útján.

Az API sikeres importálása után megjelenik az Explorer panelen, és az elérhető API-műveletek az Operatív csomópont alatt jelennek meg.

Az API szerkesztése

Az API-t szerkesztheti a Visual Studio Code-ban. Szerkessze például az API Resource Manager JSON-leírását a szerkesztőablakban az API eléréséhez használt HTTP-protokoll eltávolításához, amely a következő kódrészletben van kiemelve:

Az OpenAPI formátum szerkesztéséhez kattintson a jobb gombbal az API nevére az Explorer panelen, és válassza az OpenAPI szerkesztése lehetőséget. Végezze el a módosításokat, majd válassza a Fájl>mentése lehetőséget.

Szabályzatok alkalmazása az API-ra

Az API Management olyan szabályzatokat biztosít, amelyeket konfigurálhat az API-khoz. A szabályzatok utasítások gyűjteményei. Ezek az utasítások egymás után futnak egy API kérésén vagy válaszán. A szabályzatok lehetnek globálisak, amelyek az API Management-példányban lévő összes API-ra vonatkoznak, vagy termékre, API-ra vagy API-műveletre jellemzőek.

Ez a szakasz bemutatja, hogyan alkalmazhat gyakori bejövő és kimenő szabályzatokat az API-ra.

1. Az Explorer panelen válassza az importált petstore API alatt található Házirend lehetőséget. A szabályzatfájl megnyílik a szerkesztőablakban. Ez a fájl az API összes műveletéhez konfigurálja a szabályzatokat.

2. Frissítse a fájlt a következő tartalommal:

   <policies>
       <inbound>
           <rate-limit calls="3" renewal-period="15" />
           <base />
       </inbound>
       <outbound>
           <set-header name="Custom" exists-action="override">
               <value>"My custom value"</value>
             </set-header>
           <base />
       </outbound>
       <on-error>
           <base />
       </on-error>
   </policies>
   

   • A rate-limit szakaszban található inbound szabályzat 15 másodpercenként 3-ra korlátozza az API-ba irányuló hívások számát.
   • A set-header szakasz házirendje outbound egy egyéni válaszfejlécet ad hozzá bemutató célokra.

3. Mentse a fájlt. Ha a rendszer kéri, válassza a Feltöltés lehetőséget a fájl felhőbe való feltöltéséhez.

Az API tesztelése

Az API teszteléséhez szerezze be az előfizetési kulcsot, majd küldjön egy kérést az API Management-átjáróhoz.

Az előfizetési kulcs lekérése

Az importált API és az alkalmazott szabályzatok teszteléséhez szüksége van egy előfizetési kulcsra az API Management-példányhoz.

1. Az Explorer panelen kattintson a jobb gombbal az API Management-példány nevére.

2. Válassza az Előfizetési kulcs másolása lehetőséget. Ez a kulcs az API Management-példány létrehozásakor létrehozott beépített összes hozzáférési előfizetéshez tartozik.

   

   Figyelemfelhívás

   A teljes hozzáférésű előfizetés lehetővé teszi az API Management-példány összes API-jának elérését, és csak a jogosult felhasználók használhatják. Soha ne használja rutin API-hozzáféréshez, és ne ágyazza be a teljes hozzáférési kulcsot az ügyfélalkalmazásokba.

API-művelet tesztelése

1. Az Explorer panelen bontsa ki az importált petstore API alatti Operatív csomópontot.
2. Válasszon ki egy műveletet, például :[GET] Keresse meg a kisállatot azonosító szerint, majd kattintson a jobb gombbal a műveletre, és válassza a Tesztművelet lehetőséget.
3. A szerkesztőablakban cserélje le 5 a paramétert a petId kérelem URL-címében.
4. A szerkesztőablakban az Ocp-Apim-Subscription-Key mellett illessze be a másolt előfizetési kulcsot.
5. Válassza a Kérés elküldése elemet.

Ha a kérés sikeres, a háttérrendszer 200 OK-val és néhány adattal válaszol.

Figyelje meg a következő részleteket a válaszban:

• A Custom rendszer hozzáadja a fejlécet a válaszhoz.

Most tesztelje a sebességkorlátozó szabályzatot. Válassza a Kérés küldése elemet többször egymás után. Miután túl sok kérést küldött a konfigurált időszakban, megkapja a 429 Too Many Requests választ.

Nyomkövetési kérelmek feldolgozása

Igény szerint részletes kéréskövetési információkat is kaphat az API hibakereséséhez és hibaelhárításához.

Az API-k nyomkövetésének engedélyezésével kapcsolatos lépésekért tekintse meg az API nyomkövetésének engedélyezése című témakört. A bizalmas információk nem szándékos közzétételének korlátozása érdekében a nyomkövetés alapértelmezés szerint csak 1 óráig engedélyezett.

Az erőforrások eltávolítása

Ha már nincs rá szükség, távolítsa el az API Management-példányt a jobb gombbal kattintva, majd a Megnyitás a portálonelemre kattintva törölje az API Management szolgáltatást és annak erőforráscsoportját.

Másik lehetőségként az API Management törlése lehetőséget választva csak az API Management-példányt törölheti (ez a művelet nem törli az erőforráscsoportot).

Kapcsolódó tartalom

Ez az oktatóanyag a Visual Studio Code API Management bővítményének számos funkcióját mutatta be. Ezekkel a funkciókkal importálhatja és kezelheti az API-kat. Megtanulta végrehajtani az alábbi műveleteket:

Az API Management bővítmény további funkciókat biztosít az API-k használatához. Például hibakeresési szabályzatok (a fejlesztői szolgáltatási szinten érhető el), vagy névvel ellátott értékek létrehozása és kezelése.