Oktatóanyag: Az első API importálása és közzététele

A KÖVETKEZŐRE VONATKOZIK: Minden API Management réteg

Ez az oktatóanyag bemutatja, hogyan importálhat egy háttér - az OpenAPI specifikáció alapján létrehozott - API-t JSON formátumban az Azure API Management szolgáltatáshoz. Ebben a példában importálja a nyílt forráskódú Petstore API.

Tip

Az API-csapatok használhatják ezt a funkciót a munkaterületeken. A munkaterületek elkülönített adminisztratív hozzáférést biztosítanak az API-knak és saját API-futtatási környezetüknek.

Amikor importálja a háttér API-t az API Management-be, az API Management API a háttér API átjárója lesz. A háttér API módosítása nélkül testre szabhatja az átjárót az igényeinek megfelelően API Management. További információ: Az API átalakítása és védelme.

Ebben az oktatóanyagban az alábbiakkal fog megismerkedni:

  • API importálása az API-menedzsment rendszerbe
  • API-beállítások megtekintése és módosítása
  • Az API tesztelése az Azure portálon
  • API-kérések irányítása az API Managementen keresztül

Az importálás után kezelheti az API-t a Azure portal.

Egy új API képernyőképe az API Management portálon.

Előfeltételek

Ugrás a API Management-példányra

  1. Az Azure Portalon keresse meg és válassza ki az API Management-szolgáltatásokat:

    API Management szolgáltatások a keresési találatok között láthatók egy képernyőképen.

  2. A API Management szolgáltatások lapon válassza ki a API Management-példányt:

    Képernyőkép, amely egy API Management-példányt jelenít meg az API Management szolgáltatások oldalán.

Háttérrendszeri API importálása és közzététele

Ez a szakasz bemutatja az OpenAPI-specifikációjú háttérrendszeri API importálását és közzétételét.

  1. A API Management-példányban az oldalsáv menüjének API területén válassza a APIs lehetőséget.

  2. Válassza ki az OpenAPI csempét.

  3. A Create from OpenAPI specification (Létrehozás OpenAPI-specifikációból ) ablakban válassza a Teljes lehetőséget.

  4. Adja meg az alábbi táblázat értékeit.

    Az API-értékeket a létrehozás során vagy később a Beállítások lapra kattintva állíthatja be.

    Képernyőkép egy API portálon való létrehozásáról.

    Beállítás Érték Leírás
    OpenAPI-specifikáció https://petstore3.swagger.io/api/v3/openapi.json -vagy- https://petstore.swagger.io/v2/swagger.json Megadja az API-t implementáló háttérszolgáltatást és az API által támogatott műveleteket.

    A háttérszolgáltatás URL-címe később jelenik meg a webszolgáltatás URL-címekéntaz API Beállítások lapján.

    Az importálás után hozzáadhat, szerkeszthet, átnevezhet vagy törölhet műveleteket a specifikációban.
    Lekérdezési paraméterek belefoglalása műveleti sablonokba Kiválasztva (alapértelmezett) Megadja, hogy importálja-e a szükséges lekérdezési paramétereket a specifikációban sablonparaméterként API Management.
    Megjelenített név Az OpenAPI specifikáció URL-címének megadása után API Management kitölti ezt a mezőt a JSON alapján. A fejlesztői portálon megjelenő név.
    Név Az OpenAPI specifikáció URL-címének megadása után API Management kitölti ezt a mezőt a JSON alapján. Az API egyedi neve.
    Leírás Az OpenAPI specifikáció URL-címének megadása után API Management kitölti ezt a mezőt a JSON alapján. Az API opcionális leírása.
    URL-séma HTTPS Mely protokollok férnek hozzá az API-hoz?
    API URL-címének utótagja petstore A API Management szolgáltatás alap URL-címéhez fűzött utótag. API Management az API-kat az utótagjuk alapján különbözteti meg és irányítja, így az utótagnak egyedinek kell lennie az adott publisher minden API-jában. További információ a API Management kérelmek átirányításáról.
    Címkék Címkék a kereséshez, csoportosításhoz vagy szűréshez használható API-k rendszerezéséhez.
    Termékek Korlátlan Egy vagy több API társítása. Bizonyos szinteken az API Management példányhoz két mintatermék tartozik: Starter és Korlátlan. Az API-t úgy teheti közzé a fejlesztői portálon, hogy az API-t termékhez társítja.

    Egy termékben több API is szerepelhet, és termék-előfizetéseket kínálhat a fejlesztőknek a fejlesztői portálon keresztül. Ha ezt az API-t egy másik termékhez szeretné hozzáadni, írja be vagy válassza ki a termék nevét. Ismételje meg ezt a lépést az API több termékhez való hozzáadásához. Az API-kat később a Beállítások lapon is hozzáadhatja a termékekhez.

    További információ a termékekről: Termék létrehozása és közzététele.
    Átjárók Managed Api-átjárók, amelyek elérhetővé teszik az API-t. Ez a mező csak fejlesztői és prémium szintű szolgáltatásokban érhető el.

    Managed az API Management szolgáltatásba beépített átjárót jelöli, amelyet a Microsoft üzemeltet a Azure. A saját üzemeltetésű átjárók csak a prémium és fejlesztői szolgáltatási szinteken érhetők el. Ezeket a helyszíni vagy más felhőkben is üzembe helyezheti.

    Ha nem jelöl ki átjárókat, az API nem érhető el, és az API-kérések nem sikeresek.
    Verziózzuk ezt az API-t? Kijelölés vagy megszüntetése További információ: Az API több verziójának közzététele.

  5. Az API létrehozásához válassza a(z) Létrehozás lehetőséget.

Ha problémákat tapasztal egy API-definíció importálásával kapcsolatban, tekintse meg az API importálási korlátozásait és az ismert problémákat.

API-beállítások megtekintése és módosítása

Az API importálása után megtekintheti és módosíthatja annak beállításait és műveleteit a Azure portal.

  1. A API Management-példányban az oldalsáv menüjének API területén válassza a APIs lehetőséget.

  2. Válassza ki az importált API-t (például Swagger Petstore). Képernyőkép az API Management portálon lévő API-beállításokról.

  3. A Tervezés lapon megtekintheti és módosíthatja az API-műveleteket az OpenAPI-specifikációban, beleértve a következőket:

    • A művelet részletei, például AZ URL-cím, a metódus és a leírás
    • Kérelem- és válaszdefiníciók
    • Kérelmek és válaszok módosítására vonatkozó szabályzatok

  4. Az API-konfiguráció részleteinek megtekintéséhez és módosításához válassza a Beállítások lapot, többek között az alábbiakat:

    • Megjelenítési név, név és leírás
    • Webszolgáltatás URL-címe (háttérszolgáltatás), URL-séma és API URL-utótag
    • Termékek, címkék és verziószámozás
    • Speciálisabb beállítások, például előfizetési követelmények, biztonság és figyelés

Az API Management oktatóanyagok során többet is megtudhat az API-beállítások konfigurálásáról. Ezeket a beállításokat bármikor frissítheti az API-konfiguráció testreszabásához.

Az új API tesztelése az Azure portálon.

Az API-műveleteket közvetlenül a Azure portal hívhatja meg, így kényelmesen megtekintheti és tesztelheti a műveleteket. A portál tesztkonzolján alapértelmezés szerint az API-k meghívása a beépített access-előfizetés kulcsával történik. Az API-hívásokat egy termékre vonatkozó előfizetési kulccsal is tesztelheti.

  1. A API Management-példányban válassza a APIs>APIs>Swagger Petstore lehetőséget.

  2. Válassza a Teszt fület, majd válassza a Háziállatok keresése állapot szerint lehetőséget. A lapon az állapotlekérdezési paramétere látható. Válasszon ki egyet a rendelkezésre álló értékek közül, például függőben. Itt is hozzáadhat lekérdezési paramétereket és fejléceket.

    A HTTP-kérelem szakaszában az Ocp-Apim-Subscription-Key fejléc automatikusan ki van töltve Önnek, amelyet lát, ha a "szem" ikont választja.

  3. Válassza az Küldés lehetőséget.

    API tesztelésének képernyőképe az Azure portálon.

    A háttérrendszer 200 OK-val és néhány adattal válaszol.

Hogyan irányítja az API-kezelés a kéréseket

API Management átjáróként működik az API-ügyfelek és a háttérszolgáltatások között. Amikor egy ügyfél kérést intéz egy API Management által felügyelt API-hoz, az útválasztás a következő mintát követi:

Ügyfélkérés URL-címe:
[API Management gateway URL] + [API URL suffix] + [Operation endpoint]

API Management a kérést az alábbi mintával továbbítja a háttérszolgáltatásnak:

Háttérszolgáltatás URL-címe:
[Web service URL] + [Operation endpoint]

Megjegyzés:

A Operation végpontnak azonosnak kell lennie a API Management API-definícióban és a háttérszolgáltatásban a helyes útválasztáshoz. A nem egyező műveleti végpontok 404-et vagy más útválasztási hibákat eredményeznek.

Az alábbi táblázat az oktatóanyagban használt Petstore API-példa kontextusában ismerteti az egyes útválasztási paramétereket:

Paraméter Leírás Példa (Petstore API)
API Management átjáró URL-címe A API Management-példány alap URL-címe https://apim-hello-world.azure-api.net
API URL-címének utótagja Az API Managementben az API-t azonosító egyedi utótag (az API létrehozása során konfigurálva) petstore
A webszolgáltatás URL-címe A háttérszolgáltatás alap URL-címe, amely az OpenAPI-specifikációból származik https://petstore3.swagger.io/api/v3
Műveleti végpont Egy adott műveleti végpont elérési útja (az API-specifikációból származik) /pet/findByStatus

Példa: Háziállatok megkeresése állapot szerint

Az oktatóanyagban importált Petstore API használata:

  • Clienthívások az API kezeléshez:
    https://apim-hello-world.azure-api.net/petstore/pet/findByStatus?status=pending

    • API Management átjáró URL-címe: https://apim-hello-world.azure-api.net
    • API URL végződése: petstore
    • Műveleti végpont: /pet/findByStatus

  • API Management útvonalak a háttérrendszerbe:
    https://petstore3.swagger.io/api/v3/pet/findByStatus?status=pending

    • Webszolgáltatás URL-címe: https://petstore3.swagger.io/api/v3
    • Műveleti végpont: /pet/findByStatus (ugyanaz, mint a API Management definíciójában)

Következő lépés

Lépjen tovább a következő oktatóanyagra, amelyből megtudhatja, hogyan hozhat létre és tehet közzé egy terméket:

Termékek létrehozása és közzététele

  • Last updated on