Wyświetlasz dokumentację Apigee Edge.
Przejdź do
dokumentacji Apigee X. info
Jako dostawca interfejsu API musisz udostępnić swoje interfejsy API, poinformować o nich deweloperów, umożliwić im rejestrację i zarejestrowanie aplikacji. Apigee Edge udostępnia portal usług dla deweloperów , za pomocą którego możesz utworzyć i uruchomić własną, dostosowaną witrynę, aby świadczyć te usługi społeczności deweloperów. Więcej informacji o portalach dla programistów znajdziesz w artykule Co to jest portal dla programistów?
W kolejnych sekcjach opisujemy najważniejsze pojęcia, które musisz poznać, zanim zaczniesz rozwiązywać problemy z portalem dla programistów.
Jak działają SmartDocs
Specyfikację OpenAPI (JSON lub YAML) lub WADL opisującą Twój interfejs API można zaimportować do SmartDocs i użyć do opublikowania dokumentacji interfejsu API w portalu. Dokumentacja interfejsu API pojawi się automatycznie na karcie Interfejsy API w portalu. Deweloperzy mogą znaleźć dokumentację API w portalu i wysyłać żądania do interfejsu API w czasie rzeczywistym. Ponieważ żądania do interfejsu API pochodzą z przeglądarki, do ich obsługi wymagana jest obsługa CORS (współdzielenia zasobów między serwerami z różnych domen) . Obsługę CORS zapewnia serwer proxy "smartdocs" w Edge (w organizacji "VALIDATE"), który działa jako serwer proxy dla wszystkich żądań SmartDocs do docelowego punktu końcowego. Serwer proxy "smartdocs" jest tworzony podczas instalowania SmartDocs.
Na przykład:
Adres URL serwera proxy smartdocs jest udostępniany jako konfigurowalna właściwość w sekcji Konfiguracja -> SmartDocs -> Adres URL serwera proxy SmartDocs. Może być konieczne zmodyfikowanie tego adresu URL, jeśli Twój interfejs API znajduje się w sieci prywatnej i żądania do interfejsu API w czasie rzeczywistym wysyłane z portalu za pomocą SmartDocs nie działają.
Jak portal dla deweloperów komunikuje się z Edge
Portal dla programistów przechowuje i pobiera większość wyświetlanych informacji z Edge w tym Smartdocs, programistów, usługi i aplikacje programistów. Informacje o organizacji Edge i dane logowania administratora dewelopera można skonfigurować za pomocą polecenia menu Konfiguracja -> Portal dla deweloperów.
Więcej informacji znajdziesz w artykule zobacz Komunikacja między portalem a Edge.