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

  • 5 perc

Ha API-átjárón keresztül szeretne elérhetővé tenni egy API-t, importálnia kell és közzé kell tennie.

Ha a cipőket forgalmazó vállalat példájánál maradunk, a NorthWind Shoes azt szeretné, ha egyes partnerei le tudnák kérni a leltáradatokat és a készleten lévő mennyiségeket.

Itt megtudhatja, hogyan importálhat API-t az Azure API Managementbe, és hogyan teheti elérhetővé az API-t az ügyfelek számára.

API

A szervezetek API-kkal tesznek elérhetővé adatokat a lehetséges fejlesztők vagy a partnereik számára. Ez az elérhetővé tétel szabványosított módja. Az előző gyakorlatban például létrehozott egy API-t a termékekkel és a leltárral kapcsolatos információk megosztásához.

Az API-k elérhetővé tételéhez először importálni kell az API-t az API Managementbe. Ezután:

  • Vizualizációs eszközökkel tesztelheti az API-t az API-átjáróban.
  • Szabályzatokkal kezelheti az API-k hozzáférését.

API-keretrendszerek

Különböző API-keretrendszerek és -szabványok állnak rendelkezésre. Az API Management többféle lehetőséget nyújt az API-k importálásához.

Típus szerint Részletek
HTTP A HTTP API-t üres API-definícióval importálhatja. Az importálás után manuálisan kell megadnia az összes kötelező paramétert.
WebSocket Továbbítás beállítása háttérbeli WebSocket-szolgáltatásnak.
GraphQL Adjon át egy háttérbeli GraphQL-szolgáltatásnak, vagy importáljon egy GraphQL-sémát, és hozzon létre egy szintetikus GraphQL API-t egyéni mezőfeloldókkal.
OpenAPI Az OpenAPI egy specifikáció, amely a RESTful API-k összes végpontját és műveletét, valamint az összes bemeneti és kimeneti paramétert dokumentálja. Az OpenAPI-t korábban Swaggernek hívták.
WADL A Web Application Description Language HTTP-alapú webszolgáltatások XML-leírása. Ez egy egyszerűbb formátum és egyszerűbb, mint a WSDL.
WSDL A Web Service Description Language bármilyen hálózati szolgáltatás XML-leírása lehet, nem csak HTTP-é.

Az API-kat több háttérbeli Azure-erőforrásból is importálhatja.

Típus szerint Részletek
Logikai alkalmazás A logikai alkalmazásokkal munkafolyamatok és különböző adatforrásokkal történő integrációk automatizálhatók és hangolhatók össze.
App Service Egy Azure-beli app service-ben üzemeltetett API.
Függvényalkalmazás Triggereken keresztül hívható kiszolgáló nélküli kód.
Tárolóalkalmazás Kiszolgáló nélküli tárolók mikroszolgáltatásokhoz.

API importálása

Többféle módon is importálható API az Azure API Managementbe.

Az Azure Portalon válassza az API-k lehetőséget, majd az + API hozzáadása elemet. Először válassza ki az importálni kívánt API-típust.

Screenshot of Azure portal showing API Management service with the APIs section highlighted and selected.

Ezután adja meg az API-specifikáció hivatkozását URL-címként vagy fájlként, valamint az API nevét. Íme egy példa OpenAPI importálásához.

Screenshot of create from OpenAPI specification import settings with OpenAPI specification and display name fields highlighted.

Az Azure Portal nem a leghatékonyabb eszköz nagy mennyiségű API importálására és konfigurálására. Az API-felügyelet vertikális felskálázása során más eszközökre, például az Azure CLI-re, az Azure Resource Managerre vagy a Bicep-sablonokra vagy az Azure PowerShellre van szüksége. Használhatja például az Azure PowerShell-parancsmagokat API-átjárók üzembe helyezéséhez, termékek definiálásához és konfigurálásához, API-k importálásához, valamint felhasználók és előfizetések kezeléséhez.

Vizualizáció

Az API-átjáróval vizualizálhatja az adatok importált API-kon keresztüli feldolgozását. Műveleteket hajthat végre az adathalmazokon, és paramétereket adhat át az API-kon keresztül.

Ha Ön rendszergazda, az API-kat az Azure Portalon jelenítheti meg.

Screenshot of Azure portal API configuration showing a highlighted GET request test on an imported API.

Házirendek

A szabályzatok hatékony eszközöket nyújtanak az API-k viselkedésének konfigurálással való módosításához. Utasítások gyűjteményeiről van szó, amelyeket a rendszer az API-k kérelmei és válaszai szerint egymást követően hajt végre.

Néhány népszerű konfiguráció:

  • Formátumátalakítás XML-ről JSON-ra
  • A hívások sebességének korlátozása a beérkező hívások számának korlátozásához
  • Bejövő és kimenő fejlécek beállítása.

Az Azure Portalon különböző szabályzatokat állíthat be az API-khoz. A szabályzatokat a Tervezés lapon lehet megtekinteni.

Screenshot of Azure portal showing API configuration for all operations with base policies highlighted for inbound, outbound, and backend sections.

A Tervezés lapon új szabályzatokat is hozzáadhat.

Screenshot of Azure portal showing inbound policy options for API configuration.

Termék

A termékek API-k gyűjteményei. Egy API-t több termékhez is hozzárendelhet. Beállíthatja például, hogy egy termék, a NorthWindShoesPartners, két API-t tegyen elérhetővé a partnerek számára:

Termék NorthWindShoesPartners
1. API Leltár
2. API Tervezés

A beszállítók számára viszont csak egy API-t szeretne elérhetővé tenni:

Termék NorthWindShoesSuppliers
1. API Leltár
2. API

Hozzárendelhet szabályzatokat, hogy a termékekre különböző hozzáférési szabályok, használati kvóták és használati feltételek vonatkozzanak. Ha tehát azt szeretné, hogy a partnerek és a beszállítók különböző hozzáférési jogosultságokkal rendelkezzenek a Leltár API-hoz, rendelje hozzá az API-t két különböző termékhez.

Az Azure Portalon társíthatja az API-kat a termékekkel.

Screenshot of Azure portal showing API Management with products section highlighted.

A Használat kivételével minden tarifacsomaghoz két alapértelmezett termék érhető el: Starter és Unlimited. A Korlátlan termék éles az API-k éles környezetben történő kezelésére szolgál, mert nincs korlátozva a csatlakoztatott API-k száma. Tetszőleges számú új terméket hozhat létre. A Starter termék legfeljebb öt API-hívást/percet, és legfeljebb 100 API-hívást/hetet vehet igénybe.