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. Ebben a példában importálja a nyílt forráskód Petstore API-t.

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:

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

• Az Azure API Management terminológiája.
• Hozzon létre egy Azure API Management-példányt.

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

   

2. Az API Management-szolgáltatások lapon válassza ki az API Management-példányt.

   

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

1. Az API Management-példány bal oldali navigációs sávjában válassza az API-kat.

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.

   

   Táblázat kibontása

   Beállítás	Érték	Leírás
   OpenAPI-specifikáció	https://petstore3.swagger.io/api/v3/openapi.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 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	petstore	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. Bizonyos szinteken az API Management-példány két mintatermékkel rendelkezik: Starter és Unlimited. 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	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.

5. 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 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.

1. Az API Management-példány bal oldali navigációs sávján válassza a Swagger Petstore API-kat>.

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 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.

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

   

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

Ez az oktatóanyag bemutatta, hogyan végezheti el az alábbi műveleteket:

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