Rövid útmutató: API-központ létrehozása – Azure CLI
Hozza létre az API-központot a szervezet API-jainak leltárának elindításához. Az Azure API Center lehetővé teszi az API-k központi helyen történő nyomon követését a felderítéshez, az újrafelhasználáshoz és a szabályozáshoz.
Az API-központ létrehozása után kövesse az oktatóanyagok lépéseit az egyéni metaadatok, API-k, verziók, definíciók és egyéb információk hozzáadásához.
Előfeltételek
Ha nem rendelkezik Azure-előfizetéssel, a kezdés előtt hozzon létre egy ingyenes Azure-fiókot .
Legalább közreműködői szerepkör-hozzárendelést vagy azzal egyenértékű engedélyeket az Azure-előfizetésben.
Azure CLI esetén:
Használja a Bash-környezetet az Azure Cloud Shellben. További információ: A Bash rövid útmutatója az Azure Cloud Shellben.
Ha inkább helyi cli-referenciaparancsokat szeretne futtatni, telepítse az Azure CLI-t. Ha Windows vagy macOS rendszert használ, fontolja meg az Azure CLI Docker-tárolóban való futtatását. További információ: Az Azure CLI futtatása Docker-tárolóban.
Ha helyi telepítést használ, jelentkezzen be az Azure CLI-be az az login parancs futtatásával. A hitelesítési folyamat befejezéséhez kövesse a terminálon megjelenő lépéseket. További bejelentkezési lehetőségekért lásd : Bejelentkezés az Azure CLI-vel.
Amikor a rendszer kéri, először telepítse az Azure CLI-bővítményt. További információ a bővítményekről: Bővítmények használata az Azure CLI-vel.
Futtassa az az version parancsot a telepített verzió és a függő kódtárak megkereséséhez. A legújabb verzióra az az upgrade paranccsal frissíthet.
Feljegyzés
az apic
parancsokhoz azapic-extension
Azure CLI-bővítmény szükséges. Ha még nem használtaz 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
A Microsoft.ApiCenter-szolgáltató regisztrálása
Ha még nem tette meg, regisztrálnia kell a Microsoft.ApiCenter erőforrás-szolgáltatót az előfizetésében. Csak egyszer kell regisztrálnia az erőforrás-szolgáltatót.
Ha regisztrálni szeretné az erőforrás-szolgáltatót az előfizetésében az Azure CLI használatával, futtassa a következő az provider register
parancsot:
az provider register --namespace Microsoft.ApiCenter
A regisztrációs állapotot a következő az provider show
parancs futtatásával ellenőrizheti:
az provider show --namespace Microsoft.ApiCenter
Erőforráscsoport létrehozása
Az Azure API Center-példányokat, mint az összes Azure-erőforrást, egy erőforráscsoportban kell üzembe helyezni. Az erőforráscsoportok lehetővé teszik a kapcsolódó Azure-erőforrások rendszerezését és kezelését.
Hozzon létre egy erőforráscsoportot a az group create
paranccsal. Az alábbi példa létrehoz egy MyGroup nevű csoportot az USA keleti régiójában:
az group create --name MyGroup --location eastus
API-központ létrehozása
Hozzon létre egy API-központot a az apic create
paranccsal.
Az alábbi példa létrehoz egy MyApiCenter nevű API-központot a MyGroup erőforráscsoportban. Ebben a példában az API-központ nyugat-európai helyen van üzembe helyezve. Helyettesítse be a választott API-központ nevét, és adja meg az API-központ egyik elérhető helyét .
az apic create --name MyApiCenter --resource-group MyGroup --location westeurope
A parancs kimenete az alábbihoz hasonló. Alapértelmezés szerint az API-központ az ingyenes csomagban jön létre.
{
"dataApiHostname": "myapicenter.data.westeurope.azure-apicenter.ms",
"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/mygroup/providers/Microsoft.ApiCenter/services/myapicenter",
"location": "westeurope",
"name": "myapicenter",
"resourceGroup": "mygroup",
"sku": {
"name": "Free"
},
"systemData": {
"createdAt": "2024-06-22T21:40:35.2541624Z",
"lastModifiedAt": "2024-06-22T21:40:35.2541624Z"
},
"tags": {},
"type": "Microsoft.ApiCenter/services"
}
Az üzembe helyezés után az API-központ készen áll a használatra!
Következő lépések
Most már elkezdhet adatokat hozzáadni a leltárhoz az API-központban. Az API-k és egyéb információk rendszerezésének elősegítése érdekében először definiáljon egyéni metaadatokat az API-központban.