Szybki start: tworzenie centrum interfejsu API — interfejs wiersza polecenia platformy Azure

Artykuł
07/04/2024

Utwórz centrum interfejsów API, aby rozpocząć spis interfejsów API organizacji. Centrum interfejsów API platformy Azure umożliwia śledzenie interfejsów API w scentralizowanej lokalizacji na potrzeby odnajdywania, ponownego użycia i ładu.

Po utworzeniu centrum interfejsu API wykonaj kroki opisane w samouczkach, aby dodać niestandardowe metadane, interfejsy API, wersje, definicje i inne informacje.

Wymagania wstępne

Jeśli nie masz subskrypcji platformy Azure, przed rozpoczęciem utwórz bezpłatne konto platformy Azure.
Co najmniej przypisanie roli Współautor lub równoważne uprawnienia w subskrypcji platformy Azure.

W przypadku interfejsu wiersza polecenia platformy Azure:
- Użyj środowiska powłoki Bash w usłudze Azure Cloud Shell. Aby uzyskać więcej informacji, zobacz Szybki start dotyczący powłoki Bash w usłudze Azure Cloud Shell.
- Jeśli wolisz uruchamiać polecenia referencyjne interfejsu wiersza polecenia lokalnie, zainstaluj interfejs wiersza polecenia platformy Azure. Jeśli korzystasz z systemu Windows lub macOS, rozważ uruchomienie interfejsu wiersza polecenia platformy Azure w kontenerze Docker. Aby uzyskać więcej informacji, zobacz Jak uruchomić interfejs wiersza polecenia platformy Azure w kontenerze platformy Docker.
  - Jeśli korzystasz z instalacji lokalnej, zaloguj się do interfejsu wiersza polecenia platformy Azure za pomocą polecenia az login. Aby ukończyć proces uwierzytelniania, wykonaj kroki wyświetlane w terminalu. Aby uzyskać inne opcje logowania, zobacz Logowanie się przy użyciu interfejsu wiersza polecenia platformy Azure.
  - Po wyświetleniu monitu zainstaluj rozszerzenie interfejsu wiersza polecenia platformy Azure podczas pierwszego użycia. Aby uzyskać więcej informacji na temat rozszerzeń, zobacz Korzystanie z rozszerzeń w interfejsie wiersza polecenia platformy Azure.
  - Uruchom polecenie az version, aby znaleźć zainstalowane wersje i biblioteki zależne. Aby uaktualnić do najnowszej wersji, uruchom polecenie az upgrade.
Uwaga

az apic Polecenia wymagają rozszerzenia interfejsu wiersza polecenia platformy apic-extension Azure. Jeśli nie użyto az apic poleceń, rozszerzenie można zainstalować dynamicznie po uruchomieniu pierwszego az apic polecenia lub zainstalować rozszerzenie ręcznie. Dowiedz się więcej o rozszerzeniach interfejsu wiersza polecenia platformy Azure.

Zapoznaj się z informacjami o wersji, aby uzyskać najnowsze zmiany i aktualizacje w pliku apic-extension.

Rejestrowanie dostawcy Microsoft.ApiCenter

Jeśli jeszcze tego nie zrobiono, musisz zarejestrować dostawcę zasobów Microsoft.ApiCenter w ramach subskrypcji. Musisz zarejestrować dostawcę zasobów tylko raz.

Aby zarejestrować dostawcę zasobów w subskrypcji przy użyciu interfejsu wiersza polecenia platformy Azure, uruchom następujące az provider register polecenie:

az provider register --namespace Microsoft.ApiCenter

Stan rejestracji można sprawdzić, uruchamiając następujące az provider show polecenie:

az provider show --namespace Microsoft.ApiCenter

Tworzenie grupy zasobów

Wystąpienia usługi Azure API Center, podobnie jak wszystkie zasoby platformy Azure, muszą zostać wdrożone w grupie zasobów. Grupy zasobów umożliwiają organizowanie powiązanych zasobów platformy Azure i zarządzanie nimi.

Utwórz grupę zasobów przy użyciu az group create polecenia . Poniższy przykład tworzy grupę o nazwie MyGroup w lokalizacji Wschodnie stany USA :

az group create --name MyGroup --location eastus

Tworzenie centrum interfejsu API

Utwórz centrum interfejsu az apic create API przy użyciu polecenia .

Poniższy przykład tworzy centrum interfejsu API o nazwie MyApiCenter w grupie zasobów MyGroup . W tym przykładzie centrum interfejsu API jest wdrażane w lokalizacji Europa Zachodnia. Zastąp wybraną nazwę centrum interfejsu API i wprowadź jedną z dostępnych lokalizacji centrum interfejsu API.

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

Dane wyjściowe polecenia wyglądają podobnie do poniższych. Domyślnie centrum interfejsu API jest tworzone w planie Bezpłatna.

{
  "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 wdrożeniu centrum interfejsu API jest gotowe do użycia.

Następne kroki

Teraz możesz rozpocząć dodawanie informacji do spisu w centrum interfejsu API. Aby ułatwić organizowanie interfejsów API i innych informacji, zacznij od zdefiniowania niestandardowych metadanych w centrum interfejsu API.

Definiowanie metadanych niestandardowych

Udostępnij za pośrednictwem