Megosztás a következőn keresztül:

API-k importálása az API-központba az Azure API Managementből

  • Cikk

Ez a cikk bemutatja, hogyan importálhat (adhat hozzá) API-kat egy Azure API Management-példányból az API-központba az Azure CLI használatával. Az API Management API-k api-készlethez való hozzáadása segít felderíteni és elérhetővé tenni őket a fejlesztők, az API-programmenedzserek és a szervezet más érdekelt felei számára.

Ez a cikk két lehetőséget mutat be arra, hogy az Azure CLI használatával API-kat adhat hozzá az API-központhoz az API Managementből:

  • 1 . lehetőség – API-definíció exportálása API Management-példányból az az apim api export parancs használatával. Ezután importálja a definíciót az API-központba.

    Az API Managementből exportált API-definíció importálásának lehetséges módjai a következők:

  • 2 . lehetőség – API-k importálása közvetlenül az API Managementből az API-központba az az apic import-from-apim paranccsal.

Miután importálta az API-definíciókat vagy API-kat az API Managementből, metaadatokat és dokumentációt adhat hozzá az API-központhoz, hogy segítsen az érdekelt feleknek az API felderítésében, megértésében és felhasználásában.

Tipp.

Az API-k automatikus szinkronizálását is beállíthatja az API Managementből az API-központba. További információ: API Management-példány csatolása az API-k api-központhoz való szinkronizálásához.

Előfeltételek

  • Egy API-központ az Azure-előfizetésben. Ha még nem hozott létre egyet, olvassa el az API-központ létrehozása című rövid útmutatót.

  • Az Azure API Management egy vagy több példánya ugyanabban vagy egy másik előfizetésben. Amikor közvetlenül az API Managementből importál API-kat, az API Management-példánynak és az API-központnak ugyanabban a könyvtárban kell lennie. Ha még nem hozott létre egyet, olvassa el az Azure API Management-példány létrehozása című témakört.

  • Egy vagy több, az API Management-példányban felügyelt API-k, amelyeket fel szeretne venni az API-központba.

  • Azure CLI esetén:

    Feljegyzés

    az apic parancsokhoz az apic-extension Azure CLI-bővítmény szükséges. Ha még nem használt az apic parancsokat, a bővítmény dinamikusan telepíthető az első az apic parancs futtatásakor, vagy manuálisan is telepítheti a bővítményt. További információ az Azure CLI-bővítményekről.

    A legújabb módosításokról és frissítésekről a kibocsátási megjegyzésekben olvashat.apic-extension Bizonyos funkciókhoz szükség lehet a bővítmény előzetes verziójára vagy adott verziójára.

    Feljegyzés

    A cikkben szereplő Azure CLI-parancsok PowerShellben vagy bash-rendszerhéjban futtathatók. A különböző változószintaxis miatt szükség esetén a két rendszerhéjhoz külön parancs példákat biztosítunk.

1. lehetőség: API-definíció exportálása az API Managementből, majd importálása az API-központba

Először exportáljon egy API-t az API Management-példányból egy API-definícióba az az apim api export paranccsal. A forgatókönyvtől függően exportálhatja az API-definíciót egy helyi fájlba vagy URL-címre.

API exportálása helyi API-definíciós fájlba

Az alábbi példaparancs exportálja a my-api azonosítójú API-t az API myAPIManagement példányában. Az API OpenApiJson formátumban lesz exportálva egy helyi OpenAPI-definíciós fájlba a megadott elérési úton.

#! /bin/bash
az apim api export --api-id my-api --resource-group myResourceGroup \
    --service-name myAPIManagement --export-format OpenApiJsonFile \
    --file-path "/path/to/folder"

# Formatted for PowerShell
az apim api export --api-id my-api --resource-group myResourceGroup `
    --service-name myAPIManagement --export-format OpenApiJsonFile `
    --file-path '/path/to/folder'

API exportálása URL-címre

Az alábbi példában az az apim API exportja az API-t openApiJson formátumú my-api azonosítóval exportálja egy URL-címre az Azure Storage-ban. Az URL körülbelül 5 percig érhető el. Itt az URL-cím értékét a $link változó tárolja.

#! /bin/bash
link=$(az apim api export --api-id my-api --resource-group myResourceGroup \
    --service-name myAPIManagement --export-format OpenApiJsonUrl --query properties.value.link \
    --output tsv)

# Formatted for PowerShell
$link=$(az apim api export --api-id my-api --resource-group myResourceGroup `
    --service-name myAPIManagement --export-format OpenApiJsonUrl --query properties.value.link `
    --output tsv)

API regisztrálása az API-központban az exportált API-definícióból

Az az apic api register paranccsal regisztrálhat egy új API-t az API-központban az exportált definícióból.

Az alábbi példa egy API-t regisztrál a myAPICenter API-központban egy definitionFile.json nevű helyi OpenAPI-definíciós fájlból.

az apic api register --resource-group myResourceGroup --service-name myAPICenter --api-location "/path/to/definitionFile.json"

API-definíció importálása egy meglévő API-ba az API-központban

Az alábbi példa az az apic api definition import-specification paranccsal importál egy API-definíciót egy meglévő API-ba a myAPICenter API-központban. Itt az API-definíció a $link változóban tárolt URL-címről lesz importálva.

Ez a példa feltételezi, hogy rendelkezik egy my-api nevű API-val, valamint egy társított API 1-0-0-s verzióval, valamint egy definíciós entitás openapi-ével az API-központban. Ha nem, olvassa el az API-k hozzáadása az API-központhoz című témakört.

#! /bin/bash
az apic api definition import-specification \
    --resource-group myResourceGroup --service-name myAPICenter \
    --api-id my-api --version-id v1-0-0 \
    --definition-id openapi --format "link" --value '$link' \
    --specification '{"name":"openapi","version":"3.0.2"}'

# Formatted for PowerShell
az apic api definition import-specification `
    --resource-group myResourceGroup --service-name myAPICenter `
    --api-id my-api --version-id v1-0-0 `
    --definition-id openapi --format "link" --value '$link' `
    --specification '{"name":"openapi","version":"3.0.2"}'

2. lehetőség: API-k importálása közvetlenül az API Management-példányból

Az alábbiakban az API Management-példány api-jait az az apic import-from-apim paranccsal importálhatja az API-kból az API-központba. Ez a parancs akkor hasznos, ha több API-t szeretne importálni az API Managementből az API-központba, de egyetlen API importálására is használhatja.

Amikor API Management-példányból ad hozzá API-kat az API-központhoz az apic import-from-apim, a következő automatikusan megtörténik:

  • A rendszer minden API-verziót, definíciót és üzembe helyezési információt átmásol az API-központba.
  • Az API rendszer által generált API-nevet kap az API-központban. Megtartja a megjelenítendő nevét (címét) az API Managementből.
  • Az API életciklus-szakasza a Tervezés értékre van állítva.
  • Az Azure API Management környezetként van hozzáadva.

Felügyelt identitás hozzáadása az API-központban

Felügyelt identitás engedélyezése az API-központban

Ebben a forgatókönyvben az API-központ felügyelt identitással fér hozzá az Azure-erőforrásokhoz. Az igényeitől függően engedélyezze a rendszer által hozzárendelt vagy egy vagy több felhasználó által hozzárendelt felügyelt identitást.

Az alábbi példák bemutatják, hogyan engedélyezheti a rendszer által hozzárendelt felügyelt identitásokat az Azure Portal vagy az Azure CLI használatával. Magas szinten a konfigurációs lépések hasonlóak a felhasználó által hozzárendelt felügyelt identitásokhoz.

  1. A portálon keresse meg az API-központot.
  2. A bal oldali menü Biztonság területén válassza a Felügyelt identitások lehetőséget.
  3. Válassza ki a hozzárendelt rendszert, és állítsa be az állapotot Be értékre.
  4. Válassza a Mentés lehetőséget.

A felügyelt identitás hozzárendelése AZ API Management Service Reader szerepkörhöz

Az API-k importálásának engedélyezéséhez rendelje hozzá az API-központ felügyelt identitását az API Management Service Reader szerepkörhöz az API Management-példányban. Használhatja a portált vagy az Azure CLI-t.

  1. A portálon keresse meg az API Management-példányt.
  2. A bal oldali menüben válassza a Hozzáférés-vezérlés (IAM) lehetőséget.
  3. Válassza a + Szerepkör-hozzárendelés hozzáadása lehetőséget.
  4. A Szerepkör-hozzárendelés hozzáadása lapon állítsa be az értékeket az alábbiak szerint:
    1. A Szerepkör lapon válassza az API Management Service Reader lehetőséget.
    2. A Tagok lapon, a Hozzáférés hozzárendelése – Felügyelt identitás> kiválasztása+ Tagok kijelölése területen.
    3. A Felügyelt identitások kiválasztása lapon válassza ki az előző szakaszban hozzáadott API-központ rendszer által hozzárendelt felügyelt identitását. Kattintson a Kijelölés gombra.
    4. Válassza az Áttekintés + hozzárendelés lehetőséget.

API-k importálása az API Managementből

Az az apic import-from-apim paranccsal importálhat egy vagy több API-t az API Management-példányból az API-központba.

Feljegyzés

  • Ez a parancs az API-központban konfigurált felügyelt identitástól függ, amely olvasási engedélyekkel rendelkezik az API Management-példányhoz. Ha még nem adott hozzá vagy konfigurált felügyelt identitást, olvassa el a cikk korábbi, felügyelt identitás hozzáadása az API-központban című témakört.

  • Ha az API-központ több felügyelt identitással rendelkezik, a parancs először egy rendszer által hozzárendelt identitást keres. Ha egyik sem található, a listában kiválasztja az első felhasználó által hozzárendelt identitást.

Az összes API importálása EGY API Management-példányból

Az alábbi parancsban cserélje le az API-központ, az API-központ erőforráscsoportja, az API Management-példány és a példány erőforráscsoportjának nevét. Az API Management-példány összes API-jának megadására szolgál * .

#! /bin/bash
az apic import-from-apim --service-name <api-center-name> --resource-group <resource-group-name> \
    --apim-name <api-management-name> --apim-resource-group <api-management-resource-group-name> \
    --apim-apis '*'  

# Formatted for PowerShell
az apic import-from-apim --service-name <api-center-name> --resource-group <resource-group-name> `
    --apim-name <api-management-name> --apim-resource-group <api-management-resource-group-name> `
    --apim-apis '*'

Feljegyzés

Ha az API Management-példány sok API-val rendelkezik, az API-központba történő importálás eltarthat egy ideig.

Adott API importálása EGY API Management-példányból

Adjon meg egy API-t, amely a nevét használja az API Management-példányból.

Az alábbi parancsban cserélje le az API-központ, az API-központ erőforráscsoportja, az API Management-példány és a példány erőforráscsoportjának nevét. Adjon át egy API-nevet, például petstore-api használja a paramétert --apim-apis .

#! /bin/bash
az apic import-from-apim --service-name <api-center-name> --resource-group <resource-group-name> \
    --apim-name <api-management-name> --apim-resource-group <api-management-resource-group-name> \
    --apim-apis 'petstore-api'        

# Formatted for PowerShell
az apic import-from-apim --service-name <api-center-name> --resource-group <resource-group-name> `
    --apim-name <api-management-name> --apim-resource-group <api-management-resource-group-name> `
    --apim-apis 'petstore-api'

Feljegyzés

Adjon meg egy API-nevet az API-erőforrás nevével az API Management-példányban, nem pedig a megjelenítendő névvel. Példa: ahelyett, petstore-api hogy Petstore API.

Miután importálta az API-kat az API Managementből, megtekintheti és kezelheti az importált API-kat az API-központban.

Kapcsolódó tartalom