Zarządzanie usługami API

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

Zarządzaj usługami API za pomocą interfejsu zarządzania Apigee Edge, jak opisano w tej sekcji. Aby zarządzać usługą API za pomocą interfejsu API, przeczytaj artykuł Publikowanie interfejsów API za pomocą interfejsu Edge Management API to Publish APIs.

Omówienie usług API znajdziesz w artykule Co to jest usługa API?.

Poznaj stronę usług API

Otwórz stronę usług API w sposób opisany poniżej.

Dodawanie usługi API

Dodaj usługę API za pomocą interfejsu w sposób opisany poniżej. Aby używać interfejsu Edge API, przeczytaj artykuł Konfigurowanie usług API za pomocą interfejsu API.

Aby dodać usługę API w interfejsie Edge:

1. Otwórz stronę usług API w sposób opisany wcześniej w tej sekcji.
2. Kliknij +API Product (+Usługa API).
3. Wpisz szczegóły usługi API.
   

   Pole	Opis
   Name	Wewnętrzna nazwa usługi API. Po utworzeniu usługi API nie można zmienić jej nazwy. W nazwie nie używaj znaków specjalnych.
   Display name	Wyświetlana nazwa usługi API. Wyświetlana nazwa jest używana w interfejsie i można ją w każdej chwili edytować. Jeśli nie zostanie określona, użyta zostanie wartość pola Name (Nazwa). To pole jest wypełniane automatycznie wartością z pola Name (Nazwa). Możesz edytować lub usunąć jego zawartość. Wyświetlana nazwa może zawierać znaki specjalne.
   Description	Opis usługi API.
   Environment	Środowiska, do których usługa API będzie umożliwiać dostęp. Na przykład test lub prod.
   Access	Poziom dostępu. Szczegółowe informacje znajdziesz w artykule Poziom dostępu.
   Automatically approve access requests	Włącz automatyczne zatwierdzanie próśb o klucz w przypadku tej usługi API z dowolnej aplikacji. Aby wymagać ręcznego zatwierdzania kluczy, wyłącz tę opcję. Przeczytaj artykuły Rejestrowanie aplikacji i zarządzanie kluczami interfejsu API (interfejs) oraz Klucze aplikacji deweloperskich (interfejs API).
   Quota	Limit przydzielony, do którego chcesz się odwoływać w zasadach dotyczących limitów. Wprowadzenie wartości limitu nie powoduje automatycznego egzekwowania ograniczeń liczby wywołań, które można wykonać za pomocą usługi. Serwery proxy interfejsu API, do których odwołuje się usługa, muszą zawierać zasadę dotyczącą limitu, aby egzekwować limit. Więcej informacji znajdziesz w artykule Limity.
   Allowed OAuth Scopes	Jeśli używasz protokołu OAuth z usługą API, dozwolone zakresy OAuth, które chcesz zezwolić w usłudze API (np. Read lub inne zakresy, które aplikacje będą wysyłać z wywołaniami interfejsu API). Określ wiele zakresów jako listę rozdzieloną przecinkami. Przeczytaj artykuł Zakresy OAuth.

4. Dodaj zasoby interfejsu API dostępne w usłudze API, w tym serwery proxy interfejsu API i ścieżki zasobów.

   Jeśli na przykład dodasz do usługi serwer proxy interfejsu API „music” ze ścieżką podstawową /music, usługa API będzie zezwalać na wywołania /music. Jeśli jednak chcesz, aby usługa API umożliwiała dostęp tylko do ścieżki zasobu venues, która ma identyfikator URI /music/venues, dodaj do usługi ścieżkę zasobu /venues. W takim przypadku wywołania /music/venues?name=paramount są dozwolone, ale wywołania /music/artists?name=Jack%Johnson będą blokowane.

   Ustaw konkretną ścieżkę zasobu lub ustaw ścieżkę podstawową i wszystkie możliwe ścieżki podrzędne, określając ścieżkę zasobu jako /. Ścieżka zasobu może zawierać symbole wieloznaczne /** i /*. Symbol wieloznaczny w postaci podwójnej gwiazdki oznacza, że obsługiwane są wszystkie ścieżki podrzędne ścieżki podstawowej (ale nie ścieżka podstawowa). Pojedyncza gwiazdka oznacza, że obsługiwane są tylko identyfikatory URI o 1 poziom niżej od ścieżki podstawowej. Więcej informacji znajdziesz w dalszej części tej sekcji w artykule Konfigurowanie działania ścieżki zasobu '/', '/*' i '/**'.

   Aby dodać zasoby interfejsu API:

   1. W sekcji Zasoby interfejsu API kliknij Dodaj serwer proxy lub Dodaj ścieżkę.
   2. Wybierz, czy chcesz dodać serwer proxy interfejsu API, ścieżkę czy serwer proxy interfejsu API i ścieżkę.

      

   3. Dodaj co najmniej 1 serwer proxy interfejsu API i ścieżkę zasobu.

      Pamiętaj:

      • Zdefiniowane ścieżki zasobów dotyczą wszystkich serwerów proxy interfejsu API dodanych do usługi API.
      • Ścieżki zasobów, które są bardziej ogólne i mniej szczegółowe, mają pierwszeństwo przed tymi, które są bardziej szczegółowe. Jeśli na przykład dodasz / i /**, pierwszeństwo będzie mieć ścieżka zasobu /; ścieżka zasobu /** zostanie zignorowana.

      Na przykład:

      

   4. Kliknij Dodaj lub Dodaj i rozpocznij kolejną (aby określić dodatkowe zasoby interfejsu API).
5. (Opcjonalnie) W sekcji Apigee remote service targets (Cele usług zdalnych Apigee) powiąż usługę z co najmniej 1 celem usługi zdalnej. Jeśli nie używasz adaptera Apigee Envoy, możesz zignorować to ustawienie. Więcej informacji znajdziesz w przewodniku po korzystaniu z adaptera Apigee Envoy.

6. (Opcjonalnie) W sekcji Custom attributes (Atrybuty niestandardowe) dodaj do usługi API maksymalnie 18 atrybutów niestandardowych.

   Atrybuty niestandardowe to pary klucz-wartość, których można używać na wiele sposobów, w tym do kontrolowania wykonywania serwera proxy interfejsu API. Możesz na przykład utworzyć atrybut niestandardowy o nazwie deprecated z wartością true lub false. W przepływie serwera proxy interfejsu API możesz sprawdzić wartość atrybutu deprecated usługi API (na przykład za pomocą zmiennej verifyapikey.{policy_name}.apiproduct.deprecated która jest automatycznie dostępna po utworzeniu atrybutu niestandardowego). Jeśli jego wartość to true (wycofany), możesz zgłosić błąd za pomocą zasady Raise Fault.

7. Kliknij Zapisz.

Konfigurowanie działania ścieżki zasobu '/', '/*' i '/**'

W tej tabeli opisano domyślne działanie usługi API w przypadku różnych ścieżek zasobów. W tym przykładzie serwer proxy interfejsu API ma ścieżkę podstawową /v1/weatherapikey. Ścieżka zasobu usługi API dotyczy sufiksu ścieżki po ścieżce podstawowej.

Identyfikator URI żądania	Dozwolone w przypadku: /	Dozwolone w przypadku: /*	Dozwolone w przypadku: /**	Dozwolone w przypadku: /*/2/**	Dozwolone w przypadku: /*/2/*
/v1/weatherapikey	y	N	N	N	N
/v1/weatherapikey/	y	N	N	N	N
/v1/weatherapikey/1	y	T	T	N	N
/v1/weatherapikey/1/	y	T	T	N	N
/v1/weatherapikey/1/2	y	N	T	N	N
/v1/weatherapikey/1/2/	y	N	T	T	N
/v1/weatherapikey/1/2/3/	y	N	T	T	y
/v1/weatherapikey/1/a/2/3/	y	N	T	N	N

Domyślnie ścieżka zasobu / w usłudze API obsługuje ścieżkę podstawową i wszystkie ścieżki podrzędne. Jeśli na przykład ścieżka podstawowa serwera proxy interfejsu API to /v1/weatherapikey, usługa API obsługuje żądania do /v1/weatherapikey i do wszystkich ścieżek podrzędnych, takich jak /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA itd.

Możesz zmienić to ustawienie domyślne tak, aby ścieżka zasobu / odpowiadała tylko ścieżce podstawowej serwera proxy interfejsu API. Oznacza to, że usługa API nie będzie zezwalać na dostęp do identyfikatora URI, który zawiera cokolwiek po /. Jeśli wprowadzisz tę zmianę, w tabeli powyżej tylko 2 pierwsze wiersze w kolumnie „Dozwolone w przypadku: /” będą zawierać „T”.

Aby zmienić ustawienie domyślne, administrator systemu musi ustawić wartość właściwości features.isSingleForwardSlashBlockingEnabled w Twojej organizacji na true. Klienci korzystający z chmury mogą wysłać taką prośbę do zespołu pomocy Apigee Edge.

Edytowanie usługi API

Aby edytować usługę API:

1. Otwórz stronę usług API w sposób opisany wcześniej w tej sekcji.
2. W wierszu usługi API, którą chcesz edytować, kliknij.
3. Na stronie usługi API kliknij Edytuj.
4. W razie potrzeby edytuj pola.

   Możesz usunąć zasoby dodane do usługi API. Możesz to zrobić, jeśli zasób działa nieprawidłowo lub wymaga dalszego rozwoju. Po usunięciu zasób nie jest już częścią usługi API. Żadna aplikacja, która korzysta z usługi API, nie może już uzyskać dostępu do usuniętego zasobu. Usunięte zasoby są usuwane z usługi, ale nie z systemu, więc mogą być nadal używane przez inne usługi.

5. Kliknij Zapisz.

W Apigee Edge for Public Cloud Edge przechowuje w pamięci podręcznej te encje przez co najmniej 180 sekund po uzyskaniu do nich dostępu.

• Tokeny dostępu OAuth. Oznacza to, że odwołany token może nadal działać przez maksymalnie 3 minuty, do momentu wygaśnięcia limitu pamięci podręcznej.
• Encje Key Management Service (KMS) (aplikacje, programiści, usługi API).
• Atrybuty niestandardowe w tokenach OAuth i encjach KMS.

Usuwanie usługi API

Zanim usuniesz usługę API, musisz wyrejestrować lub odłączyć wszystkie aplikacje deweloperskie powiązane z tą usługą. Możesz to zrobić, usuwając aplikacje lub odwołując klucze interfejsu API aplikacji.

Aby usunąć usługę API:

1. Otwórz stronę usług API w sposób opisany wcześniej w tej sekcji.
2. Najedź kursorem na usługę API na liście.
3. Kliknij .
4. Aby potwierdzić operację usuwania, kliknij Usuń.