Ta strona została przetłumaczona przez Cloud Translation API.

Zarządzanie usługami API

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Usługi API możesz zarządzać za pomocą interfejsu zarządzania Apigee Edge zgodnie z opisem w tej sekcji. Informacje o zarządzaniu usługą API przy użyciu interfejsu API znajdziesz w artykule o publikowaniu interfejsów API przy użyciu interfejsu Edge Management API.

Obejrzyj film, aby dowiedzieć się, jak utworzyć usługę API.

Omówienie usług związanych z interfejsami API znajdziesz w artykule Czym jest interfejs API?

Poznawanie strony usług interfejsu API

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

Edge

Aby uzyskać dostęp do strony usług interfejsu API za pomocą interfejsu Edge:

Zaloguj się na stronie https://apigee.com/edge.
Wybierz Opublikuj > Usługi API.

Zostanie wyświetlona strona Usługi interfejsu API.

Strona API usług, która zawiera listę usług interfejsu API. Objaśnienia pokazują zadania, które można wykonać, wymienione pod ilustracjami.

Jak pokazano na poprzednim ilustracji, strona usług interfejsu API umożliwia wykonywanie następujących zadań opisanych w dalszej części tej sekcji:

Dodawanie usługi API
Edytowanie i usuwanie usługi API
Przeszukiwanie listy usług API

Klasyczna wersja Edge (Private Cloud)

Aby uzyskać dostęp do strony usług interfejsu API w klasycznym interfejsie użytkownika Edge:

Zaloguj się w http://ms-ip:9000, gdzie ms-ip to adres IP lub nazwa DNS węzła serwera zarządzania.
Kliknij Opublikuj > Produkty.

Na stronie usług interfejsu API możesz wykonywać te zadania opisane w dalszej części tej sekcji:

Dodawanie usługi API
Edytowanie i usuwanie usługi API
Przeszukiwanie listy usług API

Dodawanie usługi API

Dodaj usługę API za pomocą interfejsu użytkownika w sposób opisany poniżej. Jeśli chcesz korzystać z interfejsu Edge API, zapoznaj się z artykułem o konfigurowaniu usług API przy użyciu interfejsu API.

Aby dodać usługę API za pomocą interfejsu Edge:

Otwórz stronę usług interfejsu API w sposób opisany w tej sekcji.
Kliknij + Usługa API.

Wpisz szczegóły produktu API.

Pole	Opis
Nazwa	Wewnętrzna nazwa usługi API. Po utworzeniu usługi przez interfejs API nie można zmienić jej nazwy. Nie dodawaj znaków specjalnych w nazwie. Uwagi: Nazwy usług API muszą zawierać niepowtarzalną sekwencję znaków. Jeśli na przykład utworzysz usługę API o nazwie `productA`, a potem spróbujesz utworzyć inną usługę API o nazwie `ProductA`, wystąpi błąd. Nazwy firm, z których korzystasz do generowania przychodu, nie mogą zawierać żadnych spacji. Nazwy usług API, z których korzystasz do zarabiania, nie mogą zawierać spacji na końcu.
Wyświetlana nazwa	Wyświetlana nazwa usługi API. Wyświetlana nazwa jest używana w interfejsie i możesz ją w dowolnym momencie zmienić. Jeśli wartość nie zostanie określona, zostanie użyta wartość Nazwa. To pole jest automatycznie wypełniane wartością Nazwa. Jego zawartość możesz edytować i usuwać. Wyświetlana nazwa może zawierać znaki specjalne.
Opis	Opis usługi API.
Środowisko	Środowiska, do których produkt API ma dostęp. Na przykład `test` lub `prod`.
Dostęp	Poziom dostępu. Więcej informacji znajdziesz w artykule Poziom dostępu.
Automatyczne zatwierdzanie próśb o dostęp	Włącz automatyczne zatwierdzanie żądań kluczy dla tej usługi interfejsu API z dowolnej aplikacji. Aby wymagać ręcznego zatwierdzania kluczy, wyłącz tę opcję. Zobacz Rejestrowanie aplikacji i zarządzanie kluczami interfejsu API (interfejsem użytkownika) oraz kluczami aplikacji dla programistów (API).
Limit	Limit, do którego chcesz się odwołać w zasadach limitów. Wpisanie wartości limitu nie wymusza automatycznego ograniczenia liczby wywołań, które można wykonać za pomocą usługi. Aby egzekwować limit, serwery proxy interfejsu API, do których odwołuje się usługa, muszą zawierać zasadę dotyczącą limitów. Więcej informacji znajdziesz w artykule Limity.
Dozwolone zakresy protokołu OAuth	Jeśli w interfejsie API używasz protokołu OAuth, zezwól na zakresy protokołu OAuth, które mają być dozwolone przez usługę interfejsu API (np. zakresy odczytu lub inne zakresy, które aplikacje będą wysyłać w wywołaniach interfejsu API). Wiele zakresów możesz podać w postaci listy oddzielonej przecinkami. Zobacz Zakresy protokołu OAuth.

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

Ostrzeżenie: jeśli nie dodasz do swojej usługi API żadnych serwerów proxy interfejsu API, deweloperzy aplikacji będą mieli dostęp do wszystkich Twoich serwerów proxy interfejsu API i ścieżek zasobów.

Jeśli na przykład dodasz do usługi serwer proxy interfejsu API „music” ze ścieżką bazową /music, usługa API będzie zezwalać na wywoływanie metody /music. Jeśli jednak chcesz, aby usługa API zezwalała na dostęp tylko do ścieżki zasobu venues, która ma identyfikator URI /music/venues, dodaj do produktu ścieżkę zasobu /venues. W tym przypadku połączenia z numerem /music/venues?name=paramount są dozwolone, ale połączenia z numerem /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 /*. Podwójny symbol wieloznaczny wskazuje, że obsługiwane są wszystkie ścieżki podrzędne ścieżki bazowej (ale nie jej ścieżka). Pojedyncza gwiazdka oznacza, że obsługiwane są tylko identyfikatory URI o jeden poziom niżej od ścieżki podstawowej. Zapoznaj się z sekcją Konfigurowanie zachowania ścieżki zasobu „/”, „/*” i „/**” zgodnie z opisem w dalszej części tej sekcji.

Aby dodać zasoby interfejsu API:
1. Kliknij Dodaj serwer proxy lub Dodaj ścieżkę w sekcji Zasoby interfejsu API.
2. Wybierz, czy chcesz dodać serwer proxy interfejsu API, ścieżkę czy serwer proxy i ścieżkę interfejsu API.
3. Dodaj co najmniej 1 serwer proxy interfejsu API i ścieżkę zasobów.
  
  Ostrzeżenie: jeśli nie dodasz do swojej usługi API żadnych serwerów proxy interfejsu API, deweloperzy aplikacji będą mieli dostęp do wszystkich Twoich serwerów proxy interfejsu API i ścieżek zasobów.
  
  Pamiętaj:
  - Zdefiniowane przez Ciebie ścieżki zasobów mają zastosowanie do wszystkich serwerów proxy interfejsów API dodanych do usługi API.
  - Ścieżki, które są bardziej zintegrowane, mają pierwszeństwo przed tymi, które są bardziej szczegółowe. Jeśli na przykład dodasz / i /**, ścieżka zasobu / będzie miała pierwszeństwo, a ścieżka zasobu /** będzie ignorowana.
  Na przykład:
4. Kliknij Dodaj lub Dodaj i rozpocznij kolejne (aby określić dodatkowe zasoby interfejsu API).
Uwaga: nie możesz edytować zasobu API. Zamiast tego musisz usunąć istniejący zasób API i dodać nową wersję z poprawionymi wartościami.
(Opcjonalnie) W sekcji Zdalne cele usługi Apigee powiąż usługę z co najmniej jednym zdalnym celem usługi. Jeśli nie używasz przejściówki Apigee Envoy, możesz zignorować to ustawienie. Więcej informacji znajdziesz w przewodniku po operacjach dotyczącym adaptera Apigee Envoy.
(Opcjonalnie) W sekcji Atrybuty niestandardowe możesz dodać maksymalnie 18 atrybutów niestandardowych do produktu API.

Atrybuty niestandardowe to pary klucz/wartość, których można używać na wiele sposobów, w tym do kontrolowania wykonywania przez serwer proxy interfejsu API. Możesz na przykład utworzyć atrybut niestandardowy o nazwie deprecated z wartością prawda lub fałsz. W ramach procesu proxy interfejsu API możesz sprawdzić wartość atrybutu deprecated usługi API (np. za pomocą zmiennej verifyapikey.{policy_name}.apiproduct.deprecated, która jest automatycznie dostępna po utworzeniu atrybutu niestandardowego). Jeśli jego wartość to prawda (wycofana), możesz zgłosić błąd za pomocą zasady Zgłaszanie błędu.

Ostrzeżenie: ta nazwa atrybutu jest zarezerwowana do użytku przez Apigee i spowoduje wystąpienie błędu, jeśli jej użyjesz: access
Kliknij Zapisz.

Konfigurowanie zachowania ścieżki zasobu „/”, „/*” i „/**”

W tabeli poniżej opisano domyślne zachowanie usługi API w przypadku różnych ścieżek zasobów. W tym przykładzie ścieżka bazowa serwera proxy interfejsu API to /v1/weatherapikey. Ścieżka zasobu produktu w interfejsie API ma zastosowanie do 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	Y	T	N	N
/v1/weatherapikey/1/	Y	Y	T	N	N
/v1/weatherapikey/1/2	Y	N	T	N	N
/v1/weatherapikey/1/2/	Y	N	Y	T	N
/v1/weatherapikey/1/2/3/	Y	N	Y	Y	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 bazowa serwera proxy interfejsu API to /v1/weatherapikey, usługa API obsługuje żądania wysyłane do /v1/weatherapikey i 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 bazowej serwera proxy interfejsu API. Oznacza to, że usługa API nie będzie zezwalać na dostęp do identyfikatora URI, który zawiera jakiekolwiek dane po znaku /. Jeśli wprowadzisz tę zmianę, tylko dwa pierwsze wiersze w tabeli „Dozwolone dla /” będą zawierać „Y”.

Aby zmienić ustawienie domyślne, administrator systemu musi ustawić w organizacji wartość właściwości features.isSingleForwardSlashBlockingEnabled na true. Klienci Google Cloud mogą wysłać to żądanie do zespołu pomocy Apigee Edge.

Private Cloud: klienci Apigee Edge dla Private Cloud mogą przesłać za pomocą tego formularza żądanie ustawienia tej usługi w organizacji:

curl -u username:password -X POST -H "Content-type:application/xml" http://host:8080/v1/o/myorg -d \
"<Organization name='myorg' type='trial'> \
<Properties> \
<Property name='features.isSingleForwardSlashBlockingEnabled'>true</Property> \
<!-- other existing org properties here --> \
</Properties> \
</Organization>"

Pamiętaj, aby w tym wywołaniu interfejsu API uwzględnić inne istniejące właściwości organizacji. Jeśli tego nie zrobisz, nieokreślone właściwości zostaną usunięte i zastąpione właściwością ustawioną w tym wywołaniu.

Edytowanie usługi API

Aby edytować usługę API:

Otwórz stronę usług interfejsu API w sposób opisany w tej sekcji.
Kliknij wiersz usługi API, którą chcesz edytować.
Kliknij Edytuj na stronie usługi w interfejsie API.
Zmodyfikuj pola odpowiednio do potrzeb.
Możesz usunąć zasoby dodane do usługi API. Może to być przydatne, jeśli zasób działa nieprawidłowo lub wymaga dodatkowego rozwoju. Po usunięciu zasób ten nie będzie już częścią usługi API. Aplikacje korzystające z interfejsu API nie mają już dostępu do usuniętego zasobu. Usunięte zasoby są kasowane z usługi, ale nie są usuwane z systemu, więc mogą być nadal używane przez inne usługi.
Kliknij Zapisz.

W przypadku Apigee Edge dla chmury publicznej Edge przechowuje następujące encje w pamięci podręcznej przez co najmniej 180 sekund po uzyskaniu dostępu do encji.

tokeny dostępu OAuth. Oznacza to, że unieważniony token może nadal działać przez maksymalnie 3 minuty, aż do wygaśnięcia limitu pamięci podręcznej.
Jednostki usługi zarządzania kluczami (KMS) (aplikacje, deweloperzy, produkty API).
Atrybuty niestandardowe tokenów OAuth i encji KMS.

Usuwanie usługi API

Zanim usuniesz usługę API, musisz wyrejestrować lub wyrejestrować powiązane z nią aplikacje dewelopera. Aby to zrobić, usuń aplikacje lub anuluj klucze interfejsu API aplikacji.

Aby usunąć usługę API:

Otwórz stronę usług interfejsu API w sposób opisany w tej sekcji.
Najedź kursorem na usługę API na liście.
Kliknij .
Kliknij Usuń, aby potwierdzić operację usuwania.