Przegląd opublikowanych zmian

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Publikowanie to proces udostępniania interfejsów API deweloperom aplikacji.

Film: ten film zawiera ogólne informacje o publikowaniu za pomocą interfejsu API.

Publikowanie interfejsów API obejmuje te zadania opisane w tym temacie:

  1. Utwórz w Edge usługi API, które będą zawierać Twoje interfejsy API.
  2. Rejestrowanie deweloperów aplikacji w Edge.
  3. Zarejestruj aplikacje dewelopera w Edge.
  4. Udostępniaj dokumentację i pomoc społeczności dotyczącą interfejsów API.

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

Pierwszym zadaniem podczas publikowania jest utworzenie produktu API. Produkt interfejsu API to zbiór zasobów interfejsu API, które są oferowane jako pakiet dla programistów aplikacji. Tworzenie produktów API za pomocą interfejsu API lub interfejsu użytkownika Edge. (Aby dowiedzieć się więcej o usługach API, przeczytaj artykuł Co to jest usługa API?).

Sekwencyjny diagram od lewej do prawej przedstawiający programistę, aplikację, interfejsy API oraz usługi backendu. Ikona interfejsu API i zasoby są wyróżnione. Przerywana linia prowadzi od dewelopera do ikony aplikacji, którą stworzył. Strzałki od aplikacji do ikony interfejsu API i z powrotem do aplikacji pokazują przepływ żądania i odpowiedzi. Nad żądaniem znajduje się klucz aplikacji. Ikona interfejsu API i zasoby są wyróżnione. Pod ikoną interfejsu API znajdują się 2 zbiory ścieżek zasobów podzielone na 2 usługi interfejsu API: usługę lokalizacji i usługę multimediów. Produkt Lokalizacja ma zasoby dotyczące /krajów, /miast i /języków, a produkt Media ma zasoby dotyczące /książek, /czasopism i /filmów. Po prawej stronie interfejsu API znajdują się zasoby backendu, do których się on odwołuje, w tym baza danych, magistrala usług korporacyjnych, serwery aplikacji i ogólny backend.

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

Jako dostawca interfejsu API odpowiadasz za tworzenie interfejsów API i produktów API, które umożliwiają kontrolę dostępu, ograniczenia korzystania i inne wymagania biznesowe. Możesz na przykład:

  • Opublikuj bezpłatny interfejs API, który umożliwia dostęp tylko do odczytu do jego zasobów.
  • Opublikuj drugi interfejs API w niskiej cenie, który umożliwia odczytywanie i zapisywanie tych samych zasobów API co wersja bezpłatna, ale z mniejszym limitem dostępu, np. 1000 żądań dziennie.
  • Opublikuj trzeci produkt interfejsu API w wyższej cenie, który umożliwia odczyt i zapisywanie tego samego zasobu interfejsu API, ale z wysokim limitem dostępu.

Pamiętaj, że Edge daje Ci możliwość tworzenia produktów API, które odpowiadają wymaganiom biznesowym Twoich 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

Deweloper tworzy aplikacje, które korzystają z Twoich interfejsów API. Najpierw deweloper aplikacji musi zarejestrować się w usłudze Apigee Edge, aby móc zarejestrować aplikację. Po zarejestrowaniu aplikacji otrzymuje klucz interfejsu API, który umożliwi aplikacji dostęp do interfejsu API.

W trakcie procesu rejestracji aplikacji możesz określić, kto ma mieć dostęp do Twoich interfejsów API. W każdej chwili możesz usunąć dewelopera aplikacji, co spowoduje unieważnienie wszystkich kluczy interfejsu API powiązanych z tym deweloperem, a tym samym odebranie mu dostępu do Twoich interfejsów API.

Sekwencyjny diagram od lewej do prawej przedstawiający programistę, aplikację, interfejsy API oraz usługi backendu. Wyróżniona jest ikona dewelopera. Przerywana linia wskazuje od wyróżnionego dewelopera do ikony aplikacji, którą stworzył. Strzałki od aplikacji do ikony interfejsu API i z powrotem do aplikacji pokazują przepływ żądania i odpowiedzi. Nad żądaniem znajduje się klucz aplikacji. Pod ikoną interfejsu API znajdują się 2 zbiory ścieżek zasobów podzielone na 2 usługi interfejsu API: usługę lokalizacji i usługę multimediów. Produkt Lokalizacja ma zasoby dotyczące /krajów, /miast i /języków, a produkt Media ma zasoby dotyczące /książek, /czasopism i /filmów. Po prawej stronie interfejsu API znajdują się zasoby backendu, do których się on odwołuje, w tym baza danych, magistrala usług korporacyjnych, serwery aplikacji i ogólny backend.

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

Apigee udostępnia też narzędzia, które ułatwiają automatyzację procesu rejestracji deweloperów. Na przykład:

  • Aby zintegrować funkcję rejestracji z istniejącą witryną, użyj interfejsu API do zarządzania Apigee Edge. Interfejs Edge management API to interfejs REST, którego można używać do wykonywania wszystkich aspektów procesu rejestracji dewelopera. Więcej informacji znajdziesz w artykule Korzystanie z interfejsu Edge Management API do publikowania interfejsów API.
  • Aby zarejestrować deweloperów, użyj portalu usług dla deweloperów Apigee. Portal oferuje wbudowane wsparcie dla rejestracji deweloperów, ale też wiele innych funkcji do obsługi interfejsów API. Więcej informacji znajdziesz w artykule Co to jest portal dla deweloperów?.

Zadanie 3. Zarejestruj aplikację dewelopera w Edge

Zanim aplikacja uzyska dostęp do interfejsów API, musi zostać zarejestrowana w Edge. Tylko zarejestrowany deweloper może zarejestrować aplikację w Edge.

Sekwencyjny diagram od lewej do prawej pokazujący programistę, aplikację, interfejsy API oraz usługi backendu. Strzałki aplikacji, żądania/odpowiedzi i klucza API są podświetlone. Przerywana linia prowadzi od dewelopera do ikony stworzonej przez niego aplikacji. Strzałki od aplikacji do ikony interfejsu API i z powrotem do aplikacji pokazują przepływ żądań i odpowiedzi. Nad żądaniem znajduje się klucz aplikacji. Ikona interfejsu API i zasoby są wyróżnione. Pod ikoną interfejsu API znajdują się 2 zbiory ścieżek zasobów podzielone na 2 usługi interfejsu API: usługę lokalizacji i usługę multimediów. Produkt Lokalizacja ma zasoby dotyczące /krajów, /miast i /języków, a produkt Media ma zasoby dotyczące /książek, /czasopism i /filmów. Po prawej stronie interfejsu API znajdują się zasoby backendu, do których się on odwołuje, w tym baza danych, magistrala usług korporacyjnych, serwery aplikacji i ogólny backend.

Podczas rejestracji aplikacji deweloper wybiera co najmniej 1 produkt interfejsu API. Możesz na przykład opublikować kilka produktów interfejsu API odpowiadających różnym typom usług i planów cenowych. Deweloper aplikacji może następnie wybrać opcję z listy dostępnych produktów interfejsu API.

W odpowiedzi na rejestrację aplikacji w Edge Edge przypisuje do niej unikalny klucz interfejsu API. Aplikacja musi przekazywać ten klucz w ramach każdego żądania do zasobu interfejsu API. Klucz jest uwierzytelniony i – jeśli jest prawidłowy – prośba zostaje zrealizowana. W dowolnym momencie jako dostawca usługi możesz cofnąć klucz, aby aplikacja nie miała już dostępu do interfejsów API.

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

  • Użyj procesu ręcznego, który wymaga, aby deweloper skontaktował się z Twoją organizacją w celu zarejestrowania aplikacji. W odpowiedzi wyślesz deweloperowi klucz interfejsu API, najlepiej e-mailem.
  • Użyj interfejsu Edge management API, aby zintegrować z witryną funkcję rejestracji aplikacji i dostarczania kluczy.
  • W przypadku płatnego konta Edge użyj portalu Apigee Developer Services, który zapewnia wbudowane wsparcie dotyczące rejestracji aplikacji i dostawy klucza interfejsu API.

Więcej informacji znajdziesz w artykule Rejestrowanie aplikacji i zarządzanie kluczami API.

Zadanie 4. Opisz swoje interfejsy API

Ważnym aspektem publikowania usług interfejsu API jest udostępnianie dokumentacji i mechanizmu przesyłania opinii deweloperom. Portale dla deweloperów z funkcjami publikowania społecznościowego są coraz częściej wykorzystywane do komunikacji z społecznością programistów. Obejmuje to przekazywanie statycznych treści, takich jak dokumentacja interfejsu API i warunki korzystania z usługi, a także dynamicznych treści tworzonych przez społeczność, takich jak blogi i fora, oraz funkcji obsługi klienta.

Sekwencyjny diagram od lewej do prawej przedstawiający programistę, aplikację, interfejsy API oraz usługi backendu. Wyróżniona jest ikona dewelopera. Pod deweloperem znajduje się pole reprezentujące portal dla deweloperów. Portal zawiera dokumentację interfejsu API, przykłady, samouczki, dokumentację interfejsu API i inne materiały. Portal zawiera też blogi, fora i portal pomocy. Przerywana linia wskazuje od podświetlonego dewelopera do ikony aplikacji, którą stworzył. Strzałki od aplikacji do ikony interfejsu API i z powrotem do aplikacji wskazują przepływ żądania i odpowiedzi do ikony interfejsu API. Nad żądaniem znajduje się klucz aplikacji. Pod ikoną interfejsu API znajdują się 2 zbiory ścieżek zasobów podzielone na 2 usługi interfejsu API: usługę lokalizacji i usługę multimediów. Produkt Lokalizacja ma zasoby dotyczące /krajów, /miast i /języków, a produkt Media ma zasoby dotyczące /książek, /czasopism i /filmów. Po prawej stronie interfejsu API znajdują się zasoby backendu, do których się on odwołuje, w tym baza danych, magistrala usług korporacyjnych, serwery aplikacji i ogólny backend.

Możesz utworzyć własną witrynę, aby wdrożyć dokumentację, lub jeśli masz płatne konto Edge, możesz skorzystać z portalu Usług dla deweloperów Apigee. Portal zawiera wbudowane funkcje do obsługi dokumentacji, blogów, forów i innych typów treści, które są wymagane do obsługi społeczności deweloperów.

SmartDocs umożliwia dokumentowanie interfejsów API w portalu Usługi dla deweloperów w taki sposób, aby dokumentacja interfejsu API była w pełni interaktywna. Interaktywna dokumentacja za pomocą SmartDocs umożliwia użytkownikom portalu:

  • Informacje o interfejsie API
  • Wysyłanie żądania do interfejsu API
  • Wyświetlanie odpowiedzi z interfejsu API w czasie rzeczywistym

Na przykład rycina poniżej przedstawia interfejs API udokumentowany w portalu za pomocą SmartDocs. Ten interfejs API udostępnia informacje o pogodzie w konkretnej lokalizacji:

Temat metody interfejsu API SmartDocs, który umożliwia wywołanie interfejsu API pogody po kliknięciu przycisku w temacie.

Aby określić lokalizację, deweloper podaje wartość parametru zapytania „w”, a potem klika przycisk Wyślij żądanie, aby wyświetlić żądanie i odpowiedź w czasie rzeczywistym. Tworząc interaktywną dokumentację interfejsów API, ułatwiasz użytkownikom portalu zapoznawanie się z nimi, testowanie ich i ocenianie.

Interfejs Edge management API to interfejs API REST, który umożliwia dostęp do usług interfejsu API za pomocą dowolnego klienta HTTP. Apigee używa SmartDocs do tworzenia interaktywnej dokumentacji interfejsu Edge Management API. Dokumentację interfejsu API znajdziesz tutaj.

Więcej informacji znajdziesz w artykule Używanie SmartDocs do dokumentowania interfejsów API.