Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje
Jako dostawca interfejsu API musisz udostępniać interfejsy API, informować deweloperów o ich istnieniu, rejestrować deweloperów i umożliwiać im rejestrowanie aplikacji. Apigee Edge udostępnia portal usług dla programistów, za pomocą którego możesz tworzyć i uruchamiać własną stronę internetową, aby udostępniać te usługi społeczności programistów. Więcej informacji o portalach dla deweloperów: Co to jest portal dla deweloperów?
W następnych sekcjach opisaliśmy kluczowe zagadnienia, które musisz poznać, zanim zaczniesz rozwiązywać problemy z portalem deweloperskim.
Jak działa SmartDocs
Specyfikację OpenAPI (w formacie JSON lub YAML) lub WADL, która opisuje Twój interfejs API, możesz zaimportować do SmartDocs i użyć jej do opublikowania dokumentacji referencyjnej interfejsu API w portalu. Dokumentacja referencyjna interfejsu API automatycznie pojawi się na karcie Interfejsy API na Twoim portalu. Deweloperzy mogą znaleźć dokumentację interfejsu API w portalu i wysyłać żądania do interfejsu API na żywo. Żądania interfejsu API pochodzą z przeglądarki, więc aby mogły się udać, wymagana jest obsługa CORS (współdzielenie zasobów pomiędzy serwerami z różnych domen). Obsługa CORS jest zapewniana przez serwer proxy „smartdocs” w Edge (w organizacji „VALIDATE”), który działa jako serwer proxy dla wszystkich żądań SmartDocs do wybranego punktu końcowego. Pośrednik „smartdocs” jest tworzony, gdy instalujesz SmartDocs.
Na przykład:
Adres URL serwera proxy SmartDocs jest dostępny jako właściwość konfigurowalna w sekcji Konfiguracja > SmartDocs > Adres URL serwera proxy SmartDocs. Jeśli Twój interfejs API znajduje się w prywatnej sieci, a żądania interfejsu API w czasie rzeczywistym za pomocą SmartDocs z Twojego portalu nie działają, może być konieczne zmodyfikowanie tego adresu URL.
Komunikacja między portalem dla deweloperów a Edge
Portal deweloperów przechowuje i pobiera większość informacji wyświetlanych w Edge, w tym Smartdocs, deweloperów, produkty i aplikacje deweloperów. Informacje o organizacji i dane logowania deweloperów można skonfigurować, korzystając z menu Konfiguracja -> Devportal.
Więcej informacji znajdziesz w artykule Komunikacja między portalem a Edge.