Rychlý start: Vytvoření centra rozhraní API – Azure CLI

Článek
07/04/2024

Vytvořte centrum rozhraní API pro zahájení inventáře rozhraní API vaší organizace. Azure API Center umožňuje sledování rozhraní API v centralizované lokalitě pro zjišťování, opakované použití a zásady správného řízení.

Po vytvoření centra rozhraní API postupujte podle kroků v kurzech a přidejte vlastní metadata, rozhraní API, verze, definice a další informace.

Požadavky

Pokud ještě nemáte předplatné Azure, vytvořte si bezplatný účet Azure, než začnete.
Alespoň přiřazení role přispěvatele nebo ekvivalentní oprávnění v předplatném Azure.

Pro Azure CLI:
- Použijte prostředí Bash v Azure Cloud Shellu. Další informace najdete v tématu Rychlý start pro Bash v Azure Cloud Shellu.
- Pokud dáváte přednost místnímu spouštění referenčních příkazů rozhraní příkazového řádku, nainstalujte Azure CLI. Pokud používáte Windows nebo macOS, zvažte spuštění Azure CLI v kontejneru Docker. Další informace najdete v tématu Jak spustit Azure CLI v kontejneru Dockeru.
  - Pokud používáte místní instalaci, přihlaste se k Azure CLI pomocí příkazu az login. Pokud chcete dokončit proces ověřování, postupujte podle kroků zobrazených na terminálu. Další možnosti přihlášení najdete v tématu Přihlášení pomocí Azure CLI.
  - Po zobrazení výzvy nainstalujte rozšíření Azure CLI při prvním použití. Další informace o rozšířeních najdete v tématu Využití rozšíření v Azure CLI.
  - Spuštěním příkazu az version zjistěte verzi a závislé knihovny, které jsou nainstalované. Pokud chcete upgradovat na nejnovější verzi, spusťte az upgrade.
Poznámka:

az apic příkazy vyžadují apic-extension rozšíření Azure CLI. Pokud jste nepoužili az apic příkazy, můžete rozšíření nainstalovat dynamicky při spuštění prvního az apic příkazu nebo rozšíření nainstalovat ručně. Přečtěte si další informace o rozšířeních Azure CLI.

Podívejte se na poznámky k verzi nejnovějších změn a aktualizací v nástroji apic-extension.

Registrace poskytovatele Microsoft.ApiCenter

Pokud jste to ještě neudělali, musíte ve svém předplatném zaregistrovat poskytovatele prostředků Microsoft.ApiCenter . Poskytovatele prostředků stačí zaregistrovat jenom jednou.

Pokud chcete ve svém předplatném zaregistrovat poskytovatele prostředků pomocí Azure CLI, spusťte následující az provider register příkaz:

az provider register --namespace Microsoft.ApiCenter

Stav registrace můžete zkontrolovat spuštěním následujícího az provider show příkazu:

az provider show --namespace Microsoft.ApiCenter

Vytvoření skupiny zdrojů

Instance Azure API Center, stejně jako všechny prostředky Azure, musí být nasazené do skupiny prostředků. Skupiny prostředků umožňují uspořádat a spravovat související prostředky Azure.

Pomocí příkazu vytvořte skupinu az group create prostředků. Následující příklad vytvoří skupinu s názvem MyGroup v umístění USA – východ:

az group create --name MyGroup --location eastus

Vytvoření centra rozhraní API

Pomocí příkazu vytvořte centrum az apic create rozhraní API.

Následující příklad vytvoří centrum rozhraní API s názvem MyApiCenter ve skupině prostředků MyGroup . V tomto příkladu se centrum rozhraní API nasadí v umístění Západní Evropa . Nahraďte zvolený název centra rozhraní API a zadejte jedno z dostupných umístění centra rozhraní API.

az apic create --name MyApiCenter --resource-group MyGroup --location westeurope

Výstup příkazu vypadá podobně jako následující. Ve výchozím nastavení se centrum rozhraní API vytvoří v plánu Free.

{
  "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"
}

Po nasazení je vaše centrum rozhraní API připravené k použití.

Další kroky

Teď můžete začít přidávat informace do inventáře v centru rozhraní API. Abyste mohli rozhraní API a další informace uspořádat, začněte definováním vlastních metadat v centru rozhraní API.

Definování vlastních metadat

Sdílet prostřednictvím