Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje
Jako dostawca interfejsów API potrzebujesz sposobu na udostępnianie swoich interfejsów API, informowanie deweloperów o tych interfejsach oraz rejestrowanie deweloperów i zezwalanie na rejestrowanie aplikacji. Apigee Edge udostępnia portal usług dla programistów, za pomocą którego możesz utworzyć i uruchomić własną witrynę dostosowaną do potrzeb swojej społeczności programistów. Więcej informacji o portalach dla deweloperów znajdziesz w artykule Co to jest portal dla deweloperów?.
W sekcjach poniżej opisano kluczowe pojęcia, z którymi należy się zapoznać przed rozwiązywaniem problemów z portalem dla deweloperów.
Jak działają SmartDokumenty
Specyfikację OpenAPI (JSON lub YAML) lub WADL opisującą Twój interfejs API możesz zaimportować do SmartDokumentacja i wykorzystać do opublikowania dokumentacji API w swoim portalu. Dokumentacja API pojawi się automatycznie na karcie Interfejsy API w portalu. Deweloperzy mogą znajdować w portalu dokumentację interfejsu API i wysyłać żądania do interfejsu API na żywo. Ponieważ żądania do interfejsu API są wysyłane z przeglądarki, do ich powodzenia wymagana jest obsługa CORS (Cross-Origin Resource Share). Obsługa CORS jest zapewniana przez serwer proxy „smartdocs” w Edge (w organizacji „VALIDATE”), który działa jako serwer proxy dla wszystkich żądań Dokumentów Smart Docs wysyłanych do odpowiedniego punktu końcowego. Serwer proxy „smartdocs” jest tworzony podczas instalacji SmartDokumentów.
Na przykład:
Adres URL serwera proxy smartdocs jest widoczny jako właściwość konfigurowalna w sekcji Konfiguracja -> SmartDokumenty -> Adres URL serwera proxy SmartDokument. Zmodyfikowanie tego adresu URL może być konieczne, jeśli Twój interfejs API znajduje się w sieci prywatnej, a aktywne żądania do interfejsu SmartDocuments z Twojego portalu kończą się niepowodzeniem.
W jaki sposób portal dla programistów komunikuje się z Edge
Portal dla programistów przechowuje i pobiera większość informacji wyświetlanych z Edge, w tym Smartdocs, programistów, usług i aplikacji dla programistów. Informacje o organizacji Edge i dane logowania devadmin możesz skonfigurować przy użyciu polecenia Configuration -> Devportal.
Więcej informacji znajdziesz w artykule na temat komunikacji między portalem a Edge.