Przegląd opublikowanych zmian

Wyświetlasz dokumentację Apigee Edge.
Przejdź do dokumentacji Apigee X. info

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

Publikowanie interfejsów API obejmuje te zadania, które są opisane w tym artykule:

1. Tworzenie usług API w Edge, które grupują interfejsy API.
2. Rejestrowanie deweloperów aplikacji w Edge.
3. Rejestrowanie aplikacji deweloperów w Edge.
4. Udostępnianie dokumentacji i wsparcia społeczności w zakresie interfejsów API.

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

Pierwszym zadaniem w procesie publikowania jest utworzenie usługi API. Usługa API to zbiór zasobów interfejsu API, które są oferowane jako pakiet deweloperom aplikacji. Usługi API możesz tworzyć za pomocą interfejsu API zarządzania Edge lub interfejsu użytkownika. (Więcej informacji o usługach API znajdziesz w artykule Co to jest usługa API?).

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 usług API, które obsługują kontrolę dostępu, ograniczenia użytkowania i inne wymagania biznesowe. Możesz na przykład:

• opublikować bezpłatną usługę API, która umożliwia dostęp tylko do odczytu do jej zasobów API;
• opublikować drugą usługę API w niskiej cenie, która umożliwia dostęp do odczytu i zapisu do tych samych zasobów API co wersja bezpłatna, ale z niskim limitem dostępu, np. 1000 żądań dziennie;
• opublikować trzecią usługę API w wyższej cenie, która umożliwia dostęp do odczytu i zapisu do tego samego zasobu API, ale z wysokim limitem dostępu.

Pamiętaj, że Edge umożliwia tworzenie usług API które spełniają wymagania biznesowe 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. Deweloper aplikacji musi zarejestrować się w Apigee Edge zanim będzie mógł zarejestrować swoją aplikację. Gdy zarejestruje aplikację, otrzyma klucz interfejsu API, który umożliwi aplikacji dostęp do interfejsu API.

W procesie rejestracji aplikacji możesz kontrolować, kto ma 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 odmowę dostępu do Twoich interfejsów API.

Jako dostawca interfejsu API decydujesz, jak zarejestrować 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 ręcznie zarejestrować dewelopera w interfejsie zarządzania Edge. Więcej informacji znajdziesz w artykule Zarządzanie deweloperami aplikacji.

Apigee udostępnia też narzędzia, których możesz użyć do zautomatyzowania procesu rejestracji deweloperów. Na przykład:

• Użyj interfejsu Apigee Edge Management API, aby zintegrować funkcję rejestracji z dotychczasową witryną. Interfejs Edge Management API to interfejs API typu REST, którego możesz używać do wykonywania wszystkich czynności związanych z procesem rejestracji deweloperów. Więcej informacji znajdziesz w artykule Publikowanie interfejsów API za pomocą interfejsu Edge Management API.
• Do rejestrowania deweloperów użyj portalu Apigee Developer Services. Portal ma wbudowaną obsługę rejestracji deweloperów, ale też wiele innych funkcji, które obsługują Twoje interfejsy 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 Twoich interfejsów API, musi zostać zarejestrowana w Edge. Jednak tylko zarejestrowany deweloper może zarejestrować aplikację w Edge.

Podczas rejestracji aplikacji deweloper wybiera co najmniej 1 usługę API. Możesz na przykład opublikować kilka usług API odpowiadających różnym typom usług i planom cenowym. Deweloper aplikacji może wtedy wybrać usługę z listy dostępnych usług API.

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

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

• użyć 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, np. e-mailem;
• użyć interfejsu Edge Management API, aby zintegrować funkcję rejestracji aplikacji i dostarczania kluczy z witryną;
• w przypadku płatnego konta Edge użyć portalu Apigee Developer Services, który ma wbudowaną obsługę rejestracji aplikacji i dostarczania kluczy interfejsu API.

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

Zadanie 4. Udokumentuj interfejsy API

Ważnym aspektem publikowania usług API jest udostępnianie dokumentacji i a mechanizmu opinii deweloperów. Do komunikacji ze społecznością deweloperów coraz częściej używa się portali dla deweloperów z funkcjami publikowania w mediach społecznościowych. Obejmuje to komunikowanie treści statycznych , takich jak dokumentacja API i warunki korzystania z usługi, a także treści dynamicznych tworzonych przez społeczność , takich jak blogi i fora, oraz funkcje obsługi klienta.

Możesz utworzyć własną witrynę, aby wdrożyć dokumentację, lub, jeśli masz płatne konto Edge , możesz użyć portalu Apigee Developer Services. Portal ma wbudowaną obsługę dokumentacji, blogów, forów i innych typów treści wymaganych do obsługi społeczności deweloperów.

SmartDocs umożliwia dokumentowanie interfejsów API w portalu Developer Services w taki sposób, aby dokumentacja interfejsu API była w pełni interaktywna. Interaktywna dokumentacja z SmartDocs oznacza, że użytkownicy portalu mogą:

• przeczytać informacje o interfejsie API;
• wysłać do interfejsu API żądanie na żywo;
• wyświetlić odpowiedź na żywo zwróconą przez interfejs API.

Na przykład na ilustracji poniżej przedstawiono interfejs API udokumentowany w portalu za pomocą SmartDocs. Ten interfejs API udostępnia informacje o pogodzie w określonej lokalizacji:

Deweloper wpisuje wartość parametru zapytania „w”, aby określić lokalizację, a następnie klika przycisk Wyślij żądanie, aby zobaczyć żądanie i odpowiedź na żywo. Dzięki utworzeniu interaktywnej dokumentacji interfejsów API użytkownicy portalu mogą łatwo poznawać, testować i oceniać Twoje interfejsy API.

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

Więcej informacji znajdziesz w artykule Dokumentowanie interfejsów API za pomocą SmartDocs.