Samouczek: Tworzenie i publikowanie produktu

DOTYCZY: Wszystkie warstwy usługi API Management

W usłudze Azure API Management produkt zawiera co najmniej jeden interfejs API, limit przydziału użycia i warunki użytkowania. Po opublikowaniu produktu deweloperzy mogą subskrybować produkt i zacząć korzystać z interfejsów API produktu.

Z tego samouczka dowiesz się, jak wykonywać następujące czynności:

• Tworzenie i publikowanie produktu
• Dodawanie interfejsu API do produktu
• Uzyskiwanie dostępu do interfejsów API produktów

Wymagania wstępne

• Poznaj terminologię dotyczącą usługi Azure API Management.
• Wykonaj procedury przedstawione w następującym przewodniku Szybki start: Tworzenie wystąpienia usługi Azure API Management.
• Ponadto wykonaj zadania z następującego samouczka: Importowanie i publikowanie pierwszego interfejsu API.

Tworzenie i publikowanie produktu

Portal

1. Zaloguj się do witryny Azure Portal i przejdź do wystąpienia usługi API Management.

2. W okienku nawigacji po lewej stronie wybierz pozycję Produkty>+ Dodaj.

   

3. W oknie Dodawanie produktu wprowadź wartości opisane w poniższej tabeli, aby utworzyć produkt.

   

   Nazwa/nazwisko	Opis
   Display name	Nazwa, która ma być wyświetlana w portalu dla deweloperów.
   opis	Podaj informacje o produkcie, takie jak jego przeznaczenie, interfejsy API, do których zapewnia dostęp, i inne szczegóły.
   Stan	Wybierz pozycję Opublikowano , jeśli chcesz opublikować produkt. Aby możliwe było wywołanie interfejsów API w produkcie, produkt musi zostać najpierw opublikowany. Domyślnie nowe produkty są nieopublikowane i są widoczne tylko dla grupy Administracja istratorów.
   Wymaga subskrypcji	Wybierz, czy użytkownik musi subskrybować produkt (produkt jest chroniony), a klucz subskrypcji musi być używany do uzyskiwania dostępu do interfejsów API produktu. Jeśli subskrypcja nie jest wymagana (produkt jest otwarty), klucz subskrypcji nie jest wymagany do uzyskania dostępu do interfejsów API produktu. Zobacz Artykuł Access to product APIs (Dostęp do interfejsów API produktów) w dalszej części tego artykułu.
   Wymaga zatwierdzenia	Wybierz, jeśli chcesz, aby administrator przeglądał i akceptował lub odrzucał próby subskrypcji tego produktu. Jeśli nie wybrano, próby subskrypcji są zatwierdzane automatycznie.
   Limit liczby subskrypcji	Opcjonalnie ogranicz liczbę wielu równoczesnych subskrypcji.
   Postanowienia prawne	Możesz uwzględnić warunki użytkowania produktu, które jego subskrybenci muszą zaakceptować, aby z niego korzystać.
   Interfejsy API	Wybierz co najmniej jeden interfejs API. Interfejsy API można również dodawać po utworzeniu produktu. Aby uzyskać więcej informacji, zobacz Dodawanie interfejsów API do produktu w dalszej części tego artykułu. Jeśli produkt jest otwarty (nie wymaga subskrypcji), możesz dodać tylko ten interfejs API, który nie jest skojarzony z innym otwartym produktem.

4. Wybierz pozycję Utwórz , aby utworzyć nowy produkt.

Uwaga

Podczas konfigurowania produktu, który nie wymaga subskrypcji, należy zachować ostrożność. Ta konfiguracja może być nadmiernie permisywna i może sprawić, że interfejsy API produktu będą bardziej narażone na niektóre zagrożenia bezpieczeństwa interfejsu API.

Interfejs wiersza polecenia platformy Azure

Aby rozpocząć korzystanie z 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.

Aby utworzyć produkt, uruchom polecenie az apim product create :

az apim product create --resource-group apim-hello-word-resource-group \
    --product-name "Contoso product" --product-id contoso-product \
    --service-name apim-hello-world --subscription-required true \
    --state published --description "This is a test."

Możesz określić różne wartości produktu:

Parametr	Opis
--product-name	Nazwa, która ma być wyświetlana w portalu dla deweloperów.
--description	Podaj informacje o produkcie, takie jak jego przeznaczenie, interfejsy API, do których zapewnia dostęp, i inne szczegóły.
--state	Wybierz pozycję Opublikowane , jeśli chcesz opublikować produkt. Aby możliwe było wywołanie interfejsów API w produkcie, produkt musi zostać najpierw opublikowany. Domyślnie nowe produkty są nieopublikowane i są widoczne tylko dla grupy Administracja istratorów.
--subscription-required	Wybierz, czy użytkownik jest wymagany do subskrybowania produktu (produkt jest chroniony) lub subskrypcja nie jest wymagana (produkt jest otwarty). Zobacz Artykuł Access to product APIs (Dostęp do interfejsów API produktów) w dalszej części tego artykułu.
--approval-required	Wybierz, jeśli chcesz, aby administrator przeglądał i akceptował lub odrzucał próby subskrypcji tego produktu. Jeśli nie wybrano, próby subskrypcji są zatwierdzane automatycznie.
--subscriptions-limit	Opcjonalnie ogranicz liczbę wielu równoczesnych subskrypcji.
--legal-terms	Możesz uwzględnić warunki użytkowania produktu, które subskrybenci muszą zaakceptować, aby korzystać z produktu.

Uwaga

Podczas konfigurowania produktu, który nie wymaga subskrypcji, należy zachować ostrożność. Ta konfiguracja może być nadmiernie permisywna i może sprawić, że interfejsy API produktu będą bardziej narażone na niektóre zagrożenia bezpieczeństwa interfejsu API.

Aby wyświetlić bieżące produkty, użyj polecenia az apim product list :

az apim product list --resource-group apim-hello-word-resource-group \
    --service-name apim-hello-world --output table

Produkt można usunąć za pomocą polecenia az apim product delete :

az apim product delete --product-id contoso-product \
    --resource-group apim-hello-word-resource-group \
    --service-name apim-hello-world --delete-subscriptions true

Dodawanie dodatkowych konfiguracji

Kontynuuj konfigurowanie produktu po jego zapisaniu. W wystąpieniu usługi API Management wybierz produkt w oknie Produkty . Dodaj lub zaktualizuj:

Element	opis
Ustawienia	Metadane i stan produktu
Interfejsy API	Interfejsy API skojarzone z produktem
Zasady	Zasady stosowane do interfejsów API produktów
Kontrola dostępu	Widoczność produktu dla deweloperów lub gości
Subskrypcje	Subskrybenci produktu

Dodawanie interfejsów API do produktu

Produkty to skojarzenia co najmniej jednego interfejsu API. Możesz dołączyć wiele interfejsów API i oferować je deweloperom za pośrednictwem portalu dla deweloperów. Podczas tworzenia produktu możesz dodać co najmniej jeden istniejący interfejs API. Interfejsy API można również dodać do produktu później na stronie Produkty Ustawienia lub podczas tworzenia interfejsu API.

Dodawanie interfejsu API do istniejącego produktu

Portal

1. W lewym obszarze nawigacji wystąpienia usługi API Management wybierz pozycję Produkty.
2. Wybierz produkt, a następnie wybierz pozycję Interfejsy API.
3. Wybierz pozycję + Dodaj interfejs API.
4. Wybierz co najmniej jeden interfejs API, a następnie wybierz pozycję Wybierz.

Interfejs wiersza polecenia platformy Azure

1. Aby wyświetlić zarządzane interfejsy API, użyj polecenia az apim api list :

   az apim api list --resource-group apim-hello-word-resource-group \
       --service-name apim-hello-world --output table
   

2. Aby dodać interfejs API do produktu, uruchom polecenie az apim product add :

   az apim product api add --resource-group apim-hello-word-resource-group \
       --api-id demo-conference-api --product-id contoso-product \
       --service-name apim-hello-world
   

3. Sprawdź dodanie za pomocą polecenia az apim product api list :

   az apim product api list --resource-group apim-hello-word-resource-group \
       --product-id contoso-product --service-name apim-hello-world --output table
   

Interfejs API można usunąć z produktu za pomocą polecenia az apim product delete :

az apim product api delete --resource-group apim-hello-word-resource-group \
    --api-id demo-conference-api --product-id contoso-product \
    --service-name apim-hello-world

Dostęp do interfejsów API produktów

Po opublikowaniu produktu deweloperzy mogą uzyskiwać dostęp do interfejsów API. W zależności od konfiguracji produktu może być konieczne subskrybowanie produktu w celu uzyskania dostępu.

• Chroniony produkt — deweloperzy muszą najpierw zasubskrybować chroniony produkt, aby uzyskać dostęp do interfejsów API produktu. Po zasubskrybowaniu otrzymują klucz subskrypcji, który może uzyskiwać dostęp do dowolnego interfejsu API w tym produkcie. Jeśli utworzono wystąpienie usługi API Management, jesteś już administratorem, więc domyślnie subskrybujesz każdy produkt. Aby uzyskać więcej informacji, zobacz Subskrypcje w usłudze Azure API Management.

  Gdy klient wysyła żądanie interfejsu API z prawidłowym kluczem subskrypcji produktu, usługa API Management przetwarza żądanie i zezwala na dostęp w kontekście produktu. Można stosować zasady i reguły kontroli dostępu skonfigurowane dla produktu.

  Napiwek

  Możesz utworzyć lub zaktualizować subskrypcję użytkownika do produktu przy użyciu niestandardowych kluczy subskrypcji za pomocą interfejsu API REST lub polecenia programu PowerShell.

• Otwarty produkt — deweloperzy mogą uzyskiwać dostęp do interfejsów API otwartego produktu bez klucza subskrypcji. Można jednak skonfigurować inne mechanizmy zabezpieczania dostępu klienta do interfejsów API, w tym protokołu OAuth 2.0, certyfikatów klienta i ograniczania adresów IP wywołującego.

  Uwaga

  Otwarte produkty nie są wymienione w portalu dla deweloperów, aby dowiedzieć się więcej o lub zasubskrybować. Są one widoczne tylko dla grupy Administracja istratorów. Należy użyć innego mechanizmu, aby poinformować deweloperów o interfejsach API, do których można uzyskać dostęp bez klucza subskrypcji.

  Gdy klient wysyła żądanie interfejsu API bez klucza subskrypcji:

  • Usługa API Management sprawdza, czy interfejs API jest skojarzony z otwartym produktem. Interfejs API może być skojarzony z co najwyżej jednym otwartym produktem.

  • Jeśli otwarty produkt istnieje, przetwarza żądanie w kontekście tego otwartego produktu. Zasady i reguły kontroli dostępu skonfigurowane dla otwartego produktu można zastosować.

Aby uzyskać więcej informacji, zobacz How API Management handles requests with or without subscription keys (Jak usługa API Management obsługuje żądania z kluczami subskrypcji lub bez ich użycia).

Następne kroki

W tym samouczku zawarto informacje na temat wykonywania następujących czynności:

• Tworzenie i publikowanie produktu
• Dodawanie interfejsu API do produktu
• Uzyskiwanie dostępu do interfejsów API produktów

Przejdź do następnego samouczka:

Tworzenie pustego interfejsu API i testowanie odpowiedzi interfejsu API