Basic terminology

Interfejs programowania aplikacji – interfejs, który ułatwia jednej aplikacji korzystanie z możliwości lub danych z innej aplikacji.

Definiując stabilne, uproszczone punkty wejścia do logiki i danych aplikacji, interfejsy API umożliwiają deweloperom łatwy dostęp do logiki aplikacji stworzonej przez innych deweloperów i ponowne ich używanie. W przypadku interfejsów API internetowych ta logika i dane są udostępniane przez sieć. Aplikacje korzystające z interfejsów API są wrażliwe na zmiany, więc interfejsy API też sugerują umową. Umowa daje pewną pewność, że interfejs API z czasem zmieni się w przewidywalny sposób.

Apigee udostępnia mnóstwo informacji na temat interfejsów API oraz sprawdzonych metod ich tworzenia i używania. Aby rozpocząć, obejrzyj webcast na temat interfejsu API interfejsu API lub pobierz bezpłatny e-book Web API Design: The Missing Link Bestchodzenie for Crafting Interfaces Love Developer.

Fasada w Edge dla co najmniej 1 interfejsu API, ogólnych usług HTTP lub aplikacji (np. Node.js).

Serwer proxy interfejsu API jest zaimplementowany jako zestaw plików konfiguracji, zasad i kodu, które korzystają z zestawu zasobów udostępnianych przez Apigee Edge. Serwery proxy interfejsu API można generować i konfigurować za pomocą interfejsu zarządzania Apigee Edge albo wdrożyć je lokalnie w edytorze tekstu lub IDE.

Fasada udostępniana przez serwer proxy interfejsu API odłącza interfejs API dostępny dla programistów od usług backendu, chroniąc programistów przed zmianami w kodzie i umożliwiając innowacyjność na brzegu bez wpływu na wewnętrzne zespoły programistyczne. Gdy zespoły programistyczne wprowadzają zmiany w backendzie, deweloperzy nadal wywołują ten sam interfejs bez zakłóceń. Apigee umożliwia udostępnianie wielu interfejsów temu samemu interfejsowi API, dzięki czemu możesz dostosować podpis interfejsu API, aby spełniał potrzeby różnych nisz programistów jednocześnie.

Interfejsy API zdefiniowane przez adresy sieciowe i identyfikatory URI. Interfejs API składa się ze ścieżki podstawowej i zestawu zasobów interfejsu API. Każdy serwer proxy interfejsu API definiuje ścieżkę podstawową i opcjonalnie wiele ścieżek zasobów interfejsu API. Interfejs API można wyobrazić sobie jako zbiór identyfikatorów URI, które mają wspólną ścieżkę podstawową.

Aby ułatwić zarządzanie interfejsami API, Apigee uzupełnia te nieprzetworzone identyfikatory URI o wyświetlane nazwy i opisy. Edge umożliwia dołączanie zasad i kodu do identyfikatorów URI, co zapewnia szczegółową kontrolę nad działaniem interfejsów API i zarządzanie nimi.

Zbiór zasobów interfejsu API (URI) powiązanych z limitem lub abonamentem, który jest publikowany dla deweloperów aplikacji w momencie projektowania. Usługi API można z kolei połączyć w pakiety interfejsów API na potrzeby zarabiania.

Klucz interfejsu API jest powiązany z co najmniej jedną usługą API, wymuszając powiązanie między aplikacją a pakietem identyfikatorów URI, z których aplikacja może korzystać.

Skrót nazwy application. Termin aplikacja oznacza aplikacje mobilne, które korzystają z interfejsów API. Deweloperzy wdrażają aplikacje w różnych językach programowania oraz korzystając z różnych technologii i platform. Deweloperzy, którzy chcą korzystać z interfejsów API, rejestrują aplikacje w organizacji dostawcy interfejsów API w Apigee Edge.

Gdy aplikacja jest zarejestrowana, Apigee generuje klucz i tajny klucz interfejsu API, które identyfikują aplikację. Deweloper umieszcza w aplikacji klucz interfejsu API, który prezentuje ten klucz podczas wysyłania żądań. Usługi interfejsów API wdrażają zabezpieczenia wokół klucza interfejsu API przy użyciu bezpośredniej weryfikacji klucza interfejsu API lub protokołu OAuth.

Kontekst wykonania w środowisku wykonawczym dla serwerów proxy interfejsu API. Aby udostępniony interfejs API był dostępny przez sieć, w środowisku musi być wdrożony serwer proxy interfejsu API. Domyślnie organizacje mają dostęp do 2 środowisk: test i prod.

• Środowisko testowe jest zwykle używane do wdrażania serwerów proxy interfejsów API w trakcie programowania.
• Środowisko prod jest zwykle używane do awansowania serwerów proxy interfejsów API ze środowiska testowego po ich pełnym utworzeniu i przetestowaniu.

Kontener na wszystkie obiekty na koncie Apigee Edge, w tym serwery proxy API, usługi API, pakiety API, aplikacje i deweloperzy.

Każda organizacja, do której należysz, musi mieć konto użytkownika. Większość użytkowników ma konta tylko w jednej organizacji.

Etap przetwarzania, który jest wykonywany jako atomowa jednostka logiczna wielokrotnego użytku w ramach procesu przetwarzania serwera proxy interfejsu API.

Typowe funkcje oparte na zasadach obejmują przekształcanie formatów wiadomości, egzekwowanie kontroli dostępu, wywoływanie usług zdalnych w celu uzyskania dodatkowych informacji, maskowanie danych wrażliwych przed użytkownikami zewnętrznymi, badanie treści wiadomości pod kątem potencjalnych zagrożeń, zapisywanie typowych odpowiedzi w pamięci podręcznej w celu zwiększenia wydajności itd.

Zasady mogą być warunkowo wykonywane na podstawie treści lub kontekstu żądania lub wiadomości z odpowiedzią. Jeśli na przykład wiadomość z żądaniem została wysłana ze smartfona, może zostać uruchomiona zasada przekształcenia, aby dostosować format odpowiedzi.

Wersja interfejsu API dla programistów.

Na przykład pivotaltracker.com/services/v3 lub api.enterprise.apigee.com/v1.

Termin ten różni się od wersji, czyli numerowanego pakietu konfiguracji i zasad z kontrolą wersji w pakiecie w pakiecie proxy interfejsu API. Interfejsy API mają różne wersje; serwery proxy API mają różne wersje.