Przegląd opublikowanych zmian

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Publikowanie to proces udostępniania interfejsów API deweloperom aplikacji do użytku.

Film: ten film zawiera ogólne wprowadzenie do publikowania interfejsów API.

Interfejsy API publikowania obejmują następujące zadania opisane w tym temacie:

  1. W Edge utwórz usługi API, które łączą Twoje interfejsy API.
  2. Zarejestruj deweloperów aplikacji w Edge.
  3. rejestrować aplikacje dla deweloperów w Edge,
  4. Udostępnij dokumentację interfejsów API i zapewnij wsparcie społeczności.

Zadanie 1. Utwórz usługę API w Edge

Pierwszym zadaniem podczas publikowania jest utworzenie usługi API. Usługa API to zbiór zasobów interfejsu API, które są oferowane deweloperom aplikacji w formie pakietów. Utwórz usługi API za pomocą interfejsu Edge Management API lub interfejsu użytkownika. (więcej informacji o usługach API znajdziesz w sekcji Co to jest usługa API?).

Diagram sekwencji od lewej do prawej przedstawiający dewelopera, aplikację, interfejsy API i usługi backendu. Wyróżniona ikona i zasoby interfejsu API. Linia przerywana prowadzi od dewelopera do ikony jego aplikacji. Strzałki z i z powrotem do aplikacji pokazują przepływ żądań i odpowiedzi do ikony interfejsu API z kluczem aplikacji umieszczonym nad żądaniem. Wyróżniona ikona i zasoby interfejsu API. Pod ikoną interfejsu API znajdują się 2 zestawy ścieżek zasobów zgrupowane w ramach 2 usług API: Usługi lokalizacji i Usługi multimedialne. Usługa Lokalizacja zawiera zasoby do wykorzystania w językach /countries, /cities i /language, a usługi multimedialne z zasobami dotyczącymi /books, /journals i /movies. Po prawej stronie interfejsu API znajdują się zasoby backendu wywoływane przez interfejs API, w tym baza danych, szyna usług biznesowych, serwery aplikacji i ogólny backend.

Na tym przykładzie interfejs API składa się z 2 usług, z których każdy zawiera 3 zasoby interfejsu API.

Jako dostawca interfejsów API odpowiadasz za tworzenie interfejsów API i usług API do obsługi kontroli dostępu, ograniczeń użytkowania i wszelkich innych wymagań biznesowych. Możesz na przykład:

  • Publikowanie bezpłatnej usługi API, która umożliwia dostęp tylko do odczytu do swoich zasobów interfejsu API.
  • Opublikuj drugą usługę API za niewielką cenę, która umożliwi dostęp do tych samych zasobów interfejsu API co wersja bezpłatna, ale z niskim limitem dostępu, na przykład 1000 żądań dziennie.
  • Opublikuj trzecią usługę API za wyższą cenę, która umożliwi dostęp do odczytu i zapisu do tego samego zasobu API, ale z wysokim limitem dostępu.

Pamiętaj, że Edge daje możliwość tworzenia usług API zgodnych z wymaganiami biznesowymi interfejsów API.

Więcej informacji o tworzeniu usług API znajdziesz w artykule Tworzenie usług API.

Zadanie 2. Zarejestruj dewelopera aplikacji w Edge

Aplikacje korzystające z interfejsów API tworzy deweloper. Deweloper aplikacji rejestruje się w Apigee Edge, zanim będzie mógł ją zarejestrować. Po zarejestrowaniu aplikacji otrzyma klucz interfejsu API, który zapewni jej dostęp do interfejsu API.

W ramach procesu rejestracji aplikacji masz kontrolę nad tym, kto ma dostęp do Twoich interfejsów API. W dowolnym momencie możesz usunąć dewelopera aplikacji. Spowoduje to unieważnienie wszystkich powiązanych z nim kluczy interfejsu API, co uniemożliwi mu dostęp do interfejsów API.

Diagram sekwencji od lewej do prawej przedstawiający dewelopera, aplikację, interfejsy API i usługi backendu. Ikona dewelopera jest wyróżniona. Linia przerywana od podświetlonego dewelopera do ikony jego aplikacji. Strzałki z i z powrotem do aplikacji pokazują przepływ żądań i odpowiedzi do ikony interfejsu API z kluczem aplikacji umieszczonym nad żądaniem. Pod ikoną interfejsu API znajdują się 2 zestawy ścieżek zasobów zgrupowane w ramach 2 usług API: Usługi lokalizacji i Usługi multimedialne. Usługa Lokalizacja zawiera zasoby do wykorzystania w językach /countries, /cities i /language, a usługi multimedialne z zasobami dotyczącymi /books, /journals i /movies. Po prawej stronie interfejsu API znajdują się zasoby backendu wywoływane przez interfejs API, w tym baza danych, szyna usług biznesowych, serwery aplikacji i ogólny backend.

Jako dostawca interfejsu API decydujesz, jak rejestrować deweloperów. Możesz na przykład użyć procesu rejestracji ręcznej, w ramach którego potencjalny deweloper musi skontaktować się z Twoją organizacją, aby się zarejestrować. Potencjalny programista musi podać wszystkie niezbędne informacje, takie jak adres e-mail, imię i nazwisko oraz nazwa firmy. Jeśli zatwierdzisz prośbę dewelopera, możesz ręcznie zarejestrować dewelopera za pomocą interfejsu zarządzania urządzeniami brzegowymi. Więcej informacji znajdziesz w artykule Zarządzanie deweloperami aplikacji.

Apigee udostępnia też narzędzia, które pozwalają zautomatyzować proces rejestracji programistów. Na przykład:

  • Użyj interfejsu Apigee Edge Management API, aby zintegrować funkcję rejestracji z istniejącą witryną. Interfejs Edge Management API to interfejs API typu REST, którego można używać do wykonywania wszystkich aspektów procesu rejestracji programisty. Więcej informacji znajdziesz w artykule o używaniu interfejsu Edge Management API do publikowania interfejsów API.
  • Zarejestruj programistów, używając portalu Apigee Developer Services. Portal ma wbudowaną obsługę rejestracji programistów, ale oferuje też wiele innych funkcji obsługujących interfejsy API. Więcej informacji znajdziesz w artykule Co to jest portal dla deweloperów?.

Zadanie 3. Zarejestruj aplikację dewelopera w Edge

Aby aplikacja mogła korzystać z interfejsów API, musi być zarejestrowana w Edge. Jednak tylko zarejestrowany deweloper może zarejestrować aplikację w Edge.

Diagram sekwencji od lewej do prawej przedstawiający dewelopera, aplikację, interfejsy API i usługi backendu. Strzałki związane z aplikacją, żądaniem/odpowiedzią i kluczem interfejsu API są wyróżnione. Linia przerywana od dewelopera prowadzi do ikony utworzonej przez niego aplikacji. Strzałki z i z powrotem do aplikacji pokazują przepływ żądań i odpowiedzi do ikony interfejsu API z kluczem aplikacji umieszczonym nad żądaniem. Wyróżniona ikona i zasoby interfejsu API. Pod ikoną interfejsu API znajdują się 2 zestawy ścieżek zasobów zgrupowane w ramach 2 usług API: Usługi lokalizacji i Usługi multimedialne. Usługa Lokalizacja zawiera zasoby do wykorzystania w językach /countries, /cities i /language, a usługi multimedialne z zasobami dotyczącymi /books, /journals i /movies. Po prawej stronie interfejsu API znajdują się zasoby backendu wywoływane przez interfejs API, w tym baza danych, szyna usług biznesowych, serwery aplikacji i ogólny backend.

W chwili rejestracji aplikacji deweloper wybiera co najmniej jedną usługę API. Możesz na przykład opublikować wiele usług API odpowiadających różnym typom usług i abonamentom. Deweloper aplikacji może następnie wybrać produkty z listy dostępnych usług API.

W odpowiedzi na zarejestrowanie aplikacji na Edge przypisuje do niej unikalny klucz interfejsu API. Aplikacja musi przekazywać ten klucz interfejsu API w ramach każdego żądania do zasobu interfejsu API. Klucz jest uwierzytelniony i, jeśli jest prawidłowy, żądanie jest przyznawane. W każdej chwili jako dostawca usługi możesz unieważnić klucz, aby aplikacja nie miała dostępu do Twoich interfejsów API.

Jako dostawca interfejsu API decydujesz, jak chcesz rejestrować aplikacje. Możesz:

  • Użyj ręcznego procesu, w którym deweloper musi skontaktować się z Twoją organizacją, aby zarejestrować aplikację. W odpowiedzi możesz przesłać deweloperowi klucz interfejsu API, zwykle e-mailem.
  • Za pomocą interfejsu Edge Management API zintegruj w swojej witrynie funkcję rejestracji aplikacji i dostarczanie kluczy.
  • W przypadku płatnego konta Edge użyj portalu Apigee Developer Services, który ma wbudowaną obsługę rejestracji aplikacji i dostarczania kluczy interfejsu API.

Więcej informacji znajdziesz w artykule o rejestrowaniu aplikacji i zarządzaniu kluczami interfejsu API.

Zadanie 4. Utwórz dokumentację interfejsów API

W przypadku publikowania usług interfejsu API ważnym aspektem jest zapewnienie dokumentacji i mechanizmu przekazywania opinii przez deweloperów. Portale dla programistów z funkcjami publikowania w mediach społecznościowych są coraz częściej używane do komunikacji ze społecznością programistów. Obejmuje to przesyłanie treści statycznych, takich jak dokumentacja interfejsów API i warunki korzystania z usługi, a także dynamiczne treści przesyłane przez społeczność (np. blogi i fora) oraz funkcje obsługi klienta.

Diagram sekwencji od lewej do prawej przedstawiający dewelopera, aplikację, interfejsy API i usługi backendu. Ikona dewelopera jest wyróżniona. Poniżej dewelopera znajduje się pole, które reprezentuje portal dla programistów. Portal zawiera dokumentację API, przykłady, samouczki, dokumentację API i inne informacje. Portal ten zawiera też blogi, fora i portal pomocy. Linia przerywana wskazuje od zaznaczonego dewelopera ikonę aplikacji opracowanej przez niego. Strzałki z i z powrotem do aplikacji pokazują przepływ żądań i odpowiedzi do ikony interfejsu API. Klucz aplikacji znajduje się nad żądaniem. Pod ikoną interfejsu API znajdują się 2 zestawy ścieżek zasobów zgrupowane w ramach 2 usług API: Usługi lokalizacji i Usługi multimedialne. Usługa Lokalizacja zawiera zasoby do wykorzystania w językach /countries, /cities i /language, a usługi multimedialne z zasobami dotyczącymi /books, /journals i /movies. Po prawej stronie interfejsu API znajdują się zasoby backendu wywoływane przez interfejs API, w tym baza danych, szyna usług biznesowych, serwery aplikacji i ogólny backend.

Aby wdrożyć dokumentację, możesz utworzyć własną witrynę lub, jeśli masz płatne konto Edge, skorzystać z portalu usług dla programistów Apigee. Portal ma wbudowaną obsługę dokumentacji, blogów, forów i innych rodzajów treści, które są wymagane do wspierania społeczności deweloperów.

SmartDocs umożliwia dokumentowanie interfejsów API w portalu usług dla programistów w sposób, który zapewnia pełną interaktywność dokumentacji API. Interaktywna dokumentacja SmartDokumentacja oznacza, że użytkownicy portalu mogą:

  • Poczytaj o interfejsie API
  • Wyślij żądanie na żywo do interfejsu API
  • Wyświetlanie odpowiedzi na żywo zwróconej przez interfejs API

Na przykład na ilustracji poniżej widać interfejs API udokumentowany w portalu przy użyciu aplikacji SmartDokumentacja. Ten interfejs API dostarcza informacje o pogodzie w określonej lokalizacji:

Temat dotyczący metody interfejsu SmartDokumentacja API, który umożliwia wywołanie interfejsu API pogody przez kliknięcie przycisku w temacie.

Deweloper wpisuje wartość parametru zapytania „w”, aby określić lokalizację, a potem klika przycisk Wyślij żądanie, by zobaczyć żądanie i odpowiedź. Tworząc interaktywną dokumentację interfejsów API, ułatwiasz użytkownikom portalu poznawanie, testowanie i ocenianie interfejsów API.

Interfejs Edge Management API to interfejs API typu REST, który umożliwia dostęp do usług interfejsów API za pomocą dowolnego klienta HTTP. Apigee korzysta z dokumentów SmartDokumentacja, aby tworzyć interaktywną dokumentację interfejsu Edge Management API. Dokumentację interfejsu API znajdziesz tutaj.

Więcej informacji znajdziesz w artykule o dokumentowaniu interfejsów API za pomocą SmartDokument.