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

Az API-készlet kezelése az Azure CLI használatával

  • Cikk

Ez a cikk bemutatja, hogyan használhat az apic api parancsokat az Azure CLI-ben API-k hozzáadására és konfigurálására az API-központ készletében. Az Azure CLI parancsaival szkriptműveleteket hajthat végre az API-készlet és az API-központ egyéb aspektusai kezeléséhez.

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.

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

API, API-verzió és definíció regisztrálása

Az alábbi lépések bemutatják, hogyan hozhat létre egy API-t, és hogyan társíthat egyetlen API-verziót és API-definíciót. Az Azure API Center adatmodelljének hátteréről a főbb fogalmakban olvashat.

API létrehozása

Az az apic api create paranccsal hozzon létre egy API-t az API-központban.

Az alábbi példa létrehoz egy Petstore API nevű API-t a myResourceGroup erőforráscsoportban és a myAPICenter API-központban. Az API egy REST API.

az apic api create  --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --title "Petstore API" --type "rest"

API-verzió létrehozása

Az az apic API-verzió létrehozási parancsával hozzon létre egy verziót az API-hoz.

Az alábbi példa egy v1-0-0 nevű API-verziót hoz létre az előző szakaszban létrehozott petstore-api API-hoz. A verzió a tesztelési életciklus fázisára van állítva.

az apic api version create --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --version-id v1-0-0 --title "v1-0-0" --lifecycle-stage "testing"

API-definíció létrehozása és specifikációs fájl hozzáadása

Az az apic API definíciós parancsaival hozzáadhat egy definíciót és egy hozzá tartozó specifikációs fájlt egy API-verzióhoz.

Definíció létrehozása

Az alábbi példa az az apic api definition create paranccsal hoz létre egy openapi nevű definíciót az előző szakaszban létrehozott petstore-api API-verzióhoz.

az apic api definition create --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --version-id v1-0-0 --definition-id openapi --title "OpenAPI"

Specifikációfájl importálása

Importáljon egy specifikációs fájlt a definícióba az az apic api definition import-specification paranccsal.

Az alábbi példa egy OpenAPI-specifikációs fájlt importál egy nyilvánosan elérhető URL-címről az előző lépésben létrehozott openapi-definícióba . A name specifikációs erőforrás tulajdonságai JSON-ként version lesznek átadva.

az apic api definition import-specification \
    --resource-group myResourceGroup --service-name myAPICenter \
    --api-id petstore-api --version-id v1-0-0 \
    --definition-id openapi --format "link" \
    --value 'https://petstore3.swagger.io/api/v3/openapi.json' \
    --specification '{"name":"openapi","version":"3.0.2"}'

Tipp.

A specifikációs fájl beágyazott importálásához állítsa be a paramétertinline, --format és adja át a fájl tartalmát a --value paraméterrel.

Specifikációfájl exportálása

Ha egy API-specifikációt szeretne exportálni az API-központból egy helyi fájlba, használja az az apic api definition export-specification parancsot.

Az alábbi példa exportálja a specifikációs fájlt az előző szakaszban létrehozott openapi-definícióból egy specificationFile.json nevű helyi fájlba.

az apic api definition export-specification \
    --resource-group myResourceGroup --service-name myAPICenter \
    --api-id petstore-api --version-id v1-0-0 \
    --definition-id openapi --file-name "/Path/to/specificationFile.json"

API regisztrálása specifikációs fájlból – egyetlen lépés

Az API-t egyetlen lépésben regisztrálhatja egy helyi specifikációs fájlból az az apic api register paranccsal. Ezzel a beállítással a rendszer automatikusan létrehoz egy alapértelmezett API-verziót és -definíciót az API-hoz.

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

az apic api register --resource-group myResourceGroup \
    --service-name myAPICenter --api-location "/Path/to/specificationFile.json"
  • A parancs beállítja az API-tulajdonságokat, például a nevet és a típust a definíciófájl értékeiből.
  • A parancs alapértelmezés szerint megtervezi az API életciklus-szakaszát.
  • Létrehoz egy API-verziót az version API-definíció tulajdonsága alapján (vagy alapértelmezés szerint 1-0-0 ), valamint egy, a specifikáció formátuma szerint elnevezett API-definíciót (például openapi).

API-tulajdonságok frissítése

Az API regisztrálása után frissítheti az API tulajdonságait az az apic api frissítésével, az az apic api verziófrissítésével és az az apic api definíciófrissítési parancsaival.

Az alábbi példa frissíti a petstore-api API címét a Petstore API 2-es verziójára.

az apic api update --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --title "Petstore API v2"

Az alábbi példa hamisra állítja az API logikai belső egyéni tulajdonságát.

az apic api update --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --set custom_properties.internal=false

API-erőforrások törlése

Az az apic api delete paranccsal törölhet egy API-t, valamint annak összes verzióját és definíciós erőforrását. Példa:

az apic api delete \
    --resource-group myResourceGroup --service-name myAPICenter \
    --api-id petstore-api

Az egyes API-verziók és -definíciók törléséhez használja az az apic api-verzió törlését , illetve az az apic api-definíció törlését.

Kapcsolódó tartalom