Basic terminology

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X.
Informacje

W Apigee jest kilka koncepcji, które są wspólnymi pomysłami o wyjątkowym znaczeniu.

Termin Definicja
Interfejs API

Interfejs programowania aplikacji – interfejs ułatwiający jednej aplikacji korzystanie z funkcji lub danych z innej aplikacji.

Dzięki zdefiniowaniu stabilnych, uproszczonych punktów wejścia do logiki i danych aplikacji interfejsy API umożliwiają deweloperom łatwy dostęp do logiki aplikacji stworzonej przez innych programistów i jej ponowne użycie. W przypadku interfejsów API w internecie ta logika i dane są dostępne w sieci. Aplikacje korzystające z interfejsów API są wrażliwe na zmiany, dlatego interfejsy API również stanowią umowę. Umowa zapewnia pewien poziom pewności, że z czasem interfejs API będzie się zmieniał w przewidywalny sposób.

Apigee udostępnia mnóstwo informacji o interfejsach API oraz sprawdzonych metodach ich tworzenia i korzystania. Aby rozpocząć, obejrzyj webcast na temat projektowania interfejsów API lub pobierz bezpłatną e-booka Projektowanie interfejsów API: najlepsze praktyki dotyczące tworzenia interfejsów, które uwielbiają deweloperzy.

Serwer proxy interfejsu API

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

Proxies API są implementowane jako zestaw plików konfiguracji, zasad i kodu, które korzystają z zestawu zasobów udostępnianych przez Apigee Edge. Proxies API można generować i konfigurować za pomocą interfejsu zarządzania Apigee Edge lub implementować lokalnie w edytorze tekstu lub środowisku IDE.

Interfejs API udostępniany przez serwer proxy oddziela interfejs API dla deweloperów od usług back-endowych, chroniąc deweloperów przed zmianami w kodzie i umożliwiając innowacje na urządzeniach peryferyjnych bez wpływu na wewnętrzne zespoły programistyczne. Gdy zespoły programistów wprowadzają zmiany w backendzie, deweloperzy nadal mogą korzystać z tego samego interfejsu. Apigee umożliwia udostępnianie wielu interfejsów tego samego interfejsu API, co pozwala na dostosowywanie podpisu interfejsu API do potrzeb różnych nisz programistycznych jednocześnie.

Ścieżka i zasoby podstawowe interfejsu API

interfejsy API zdefiniowane za pomocą adresów sieciowych i identyfikatorów URI; Interfejs API składa się z ścieżki podstawowej i zestawu zasobów interfejsu API. Każde proxy interfejsu API definiuje ścieżkę podstawową i opcjonalnie wiele ścieżek zasobów interfejsu API. Interfejs API to po prostu zbiór identyfikatorów URI, z których każdy ma wspólną ścieżkę podstawową.

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

Usługa API

Kolekcja zasobów interfejsu API (identyfikatorów URI) połączona z limitem miejsca lub planem usług, która jest publikowana dla programistów aplikacji w czasie projektowania. Produkty interfejsu API można z kolei łączyć w pakiety interfejsu API w celu zarabiania.

Klucz interfejsu API jest powiązany z co najmniej 1 usługą interfejsu API, co powoduje powiązanie aplikacji z pakietem identyfikatorów URI, których może ona używać.

Pakiet interfejsu API Kolekcja produktów interfejsu API, które są prezentowane deweloperom jako pakiet i są zazwyczaj powiązane z abonamentem określonym w ramach monetyzacji.
aplikacja

Skrót od aplikacja. Termin aplikacja odnosi się do aplikacji mobilnych, które korzystają z interfejsów API. Deweloperzy implementują aplikacje w różnych językach programowania, korzystając z różnych technologii i platform. Deweloperzy, którzy chcą korzystać z interfejsów API, rejestrują aplikacje w organizacji dostawcy interfejsu API w usłudze Apigee Edge.

Gdy aplikacja zostanie zarejestrowana, Apigee wygeneruje klucz interfejsu API i klucz tajny, które identyfikują aplikację. Deweloperzy umieszczają klucz interfejsu API w aplikacji, która przedstawia klucz podczas wysyłania żądań. Usługi API zapewniają bezpieczeństwo klucza API poprzez bezpośrednią weryfikację klucza API lub OAuth.

środowisko

Kontekst wykonywania w czasie działania w przypadku proxy interfejsu API. Serwer proxy interfejsu API musi zostać wdrożony w środowisku, zanim udostępniany przez niego interfejs API będzie dostępny w sieci. Domyślnie organizacje mają 2 środowiska: test i produkcyjne.

  • Środowisko testowe jest zwykle używane do wdrażania za pomocą interfejsu API w ramach procesu programowania.
  • Środowisko prod jest zwykle używane do promowania za pomocą interfejsu API proxy z otoczenia testowego po jego pełnym opracowaniu i przetestowaniu.
organizacja

Kontenery zawierające wszystkie obiekty na koncie Apigee Edge, w tym proxy interfejsu API, produkty interfejsu API, pakiety interfejsu API, aplikacje i deweloperów.

W przypadku każdej organizacji, której jesteś członkiem, musisz mieć konto użytkownika. (większość użytkowników będzie mieć konto tylko w jednej organizacji).

zasady

Krok przetwarzania, który jest wykonywany jako niepodzielny, wielokrotnego użytku element logiki w przepływie przetwarzania 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 poufnych danych przed użytkownikami zewnętrznymi, sprawdzanie treści wiadomości pod kątem potencjalnych zagrożeń, buforowanie typowych odpowiedzi w celu poprawy wydajności itp.

Zasady mogą być uruchamiane warunkowo na podstawie treści lub kontekstu żądania bądź odpowiedzi. Jeśli wiadomość z prośbą została wysłana ze smartfona, może zostać wykonana zasada przekształcenia w celu dostosowania formatu odpowiedzi.

Ścieżka zasobu interfejsu API Ścieżka zasobu to koncepcja REST, która jest identyfikatorem URI (Uniform Resource Identifier) wskazujący ścieżkę sieciową do danego zasobu.
wersja

Wersja interfejsu API dla deweloperów.

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

Termin ten różni się od wersji, która jest ponumerowanym pakietem konfiguracji i zasad kontrolowanych przez wersję, w pakiecie proxy interfejsu API. Interfejsy API mają wersje, a proxy interfejsów API mają wersje.

wersja Ponumerowany pakiet konfiguracji i zasad z kontrolą wersji, zapakowany w serwer proxy API. Termin ten różni się od wersji, która jest interfejsem API dla programistów. Zobacz wersję powyżej.