Oktatóanyag: Az első API importálása és közzététele
A KÖVETKEZŐRE VONATKOZIK: Minden API Management-szint
Ez az oktatóanyag bemutatja, hogyan importálhat egy OpenAPI specifikációs háttér API-t JSON formátumban az Azure API Managementbe. A Microsoft biztosítja a példában használt háttér API-t, és az Azure-ban üzemelteti a következő címen https://conferenceapi.azurewebsites.net: .
A háttérrendszeri API API Management szolgáltatásba történő importálása után az API Management API lesz a háttérrendszeri API homlokzata. A homlokzatot igény szerinti testreszabhatja az API Managementben a háttérrendszeri API módosítása nélkül. 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 Managementbe
- Az API tesztelése az Azure Portalon
Az importálás után kezelheti az API-t az Azure Portalon.
Előfeltételek
Nyissa meg az API Management-példányát
Az Azure Portalon keresse meg és válassza ki az API Management-szolgáltatásokat.
Az API Management-szolgáltatások lapon válassza ki az API Management-példányt.
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.
Az API Management-példány bal oldali navigációs sávjában válassza az API-kat.
Válassza ki az OpenAPI csempét.
A Create from OpenAPI specification (Létrehozás OpenAPI-specifikációból ) ablakban válassza a Teljes lehetőséget.
Adja meg az alábbi táblázat értékeit.
Az API-értékeket a létrehozás során vagy később is beállíthatja a Gépház lapon.
Beállítás Érték Leírás OpenAPI-specifikáció https://conferenceapi.azurewebsites.net?format=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ént az API Gépház 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 az API Managementben. Megjelenített név Az OpenAPI specifikáció URL-címének megadása után az 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 az 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 az 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érhetnek hozzá az API-hoz. API URL-címének utótagja conference Az API Management szolgáltatás alap URL-címéhez fűzött utótag. Az API Management az API-kat az utótagjuk alapján különbözteti meg, így az utótagnak egyedinek kell lennie az adott közzétevő összes API-jában. 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. Minden API Management-példányhoz két mintatermék tartozik: Starter és Unlimited. Az API-t úgy teheti közzé, hogy az API-t egy termékhez társítja, amely ebben a példában Korlátlan .
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. A Gépház oldalról később api-kat is hozzáadhat a termékekhez.
További információ a termékekről: Termék létrehozása és közzététele.Átjárók Felügyelt 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.
A felügyelt az API Management szolgáltatásba beépített átjárót jelöli, amelyet a Microsoft üzemeltet az Azure-ban. 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 nincs átjáró kiválasztva, az API nem lesz elérhető, és az API-kérések nem lesznek sikeresek.Verziószámba iktassa ezt az API-t Kijelölés vagy kijelölés megszüntetése További információ: Az API több verziójának közzététele. Feljegyzés
Ahhoz, hogy az API-t közzétehesse az API-felhasználók számára, hozzá kell rendelnie egy termékhez.
Az API létrehozásához válassza a Létrehozás lehetőséget .
Ha problémákat tapasztal egy API-definíció importálásával kapcsolatban, tekintse meg az ismert problémák és korlátozások listáját.
Az új API tesztelése az Azure Portalon
Az API-műveleteket közvetlenül az Azure Portalról 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 teljes hozzáférésű előfizetés kulcsával történik. Az API-hívásokat egy termékre vonatkozó előfizetési kulccsal is tesztelheti.
Az API Management-példány bal oldali navigációs sávján válassza az API-k Demo Conference API-ját>.
Válassza a Teszt fület, majd a GetSpeakers lehetőséget. A lapon lekérdezési paraméterek és fejlécek láthatók, ha vannak ilyenek.
A HTTP-kérelem szakaszban az Ocp-Apim-Subscription-Key fejléc automatikusan ki van töltve Önnek, amelyből láthatja, hogy a "szem" ikont választja-e.
Válassza az Küldés lehetőséget.
A háttérrendszer 200 OK-val és néhány adattal válaszol.
Következő lépések
Ez az oktatóanyag bemutatta, hogyan végezheti el az alábbi műveleteket:
- Az első API importálása
- Az API tesztelése az Azure Portalon
Lépjen tovább a következő oktatóanyagra, amelyből megtudhatja, hogyan hozhat létre és tehet közzé egy terméket: