Zarządzaj zasobami

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

Zarządzanie zasobami i ich zrozumienie opisano w sekcjach poniżej.

Informacje o zasobach

Wiele typów zasad opiera się na zasobach. Zasoby to pliki, które implementują kod lub konfigurację wykonywaną przez zasadę po dołączeniu do proxy interfejsu API. W niektórych przypadkach, np. w przypadku zasad JavaScript i JavaCallout, zasada po prostu definiuje punkt przyłączenia w proxy interfejsu API, w którym powinien być wykonywany kod. Zasada JavaScript lub JavaCallout to wskaźnik do zasobu.

Ten przykładowy kod JavaScriptu ustawia ścieżkę żądania HTTP na wartość zmiennej proxy.basepath.

request.headers["RequestPath"] = context.getVariable("proxy.basepath");

Typy zasobów

W poniższej tabeli znajdziesz podsumowanie typów zasobów:

Miejsce przechowywania zasobów

Zasoby mogą być przechowywane w jednej z tych 3 lokalizacji:

• Wersja proxy interfejsu API: zasoby są dostępne tylko dla wersji proxy interfejsu API, w których są uwzględnione. Możesz na przykład dołączyć zasób JavaScript w wersji 1 proxy interfejsu API, a potem zmienić implementację, aby w wersji 2 proxy używać skryptu w języku Python. Wersja 1 ma dostęp tylko do zasobu JavaScript, a wersja 2 ma dostęp tylko do zasobu Python.
• Środowisko: gdy zasoby są przechowywane w środowisku (np. test lub prod), są dostępne dla każdego proxy interfejsu API wdrożonego w tym samym środowisku.
• Organizacja: gdy zasoby są przechowywane w organizacji, są dostępne dla każdego serwera proxy interfejsu API wdrożonego w dowolnym środowisku.

Repozytoria są dostępne pod tymi identyfikatorami URI, zgodnie z opisem w interfejsie Resource files API i w dalszej części artykułu Zarządzanie zasobami za pomocą interfejsu API:

• Organizacja: /organizations/{org}/resourcefiles
• Środowisko: /organizations/{org}/environments/{env}/resourcefiles
• Proxy interfejsu API: /organizations/{org}/apis/{api}/revisions/{rev}/resources

W tabeli poniżej znajdziesz metody, których możesz użyć do tworzenia, aktualizowania i usuwania zasobów w poszczególnych repozytoriach:

Na przykład wszystkie pliki JavaScript dostępne w środowisku test są przechowywane w tym repozytorium i są dostępne dla każdego proxy interfejsu API działającego w środowisku test:

/organizations/{org}/environments/test/resourcefiles/jsc

Rozwiązywanie nazw zasobów

Edge rozpoznaje nazwy zasobów od najbardziej szczegółowego do najbardziej ogólnego zakresu. Nazwy zasobów są rozpoznawane „w górę łańcucha”, od poziomu wersji proxy interfejsu API, przez poziom środowiska, aż po poziom organizacji (tylko Edge).

Załóżmy, że ten sam zasób został wypełniony w 2 różnych repozytoriach: w wersji proxy interfejsu API i w środowisku prod.

Rozważmy proxy interfejsu API skonfigurowany za pomocą tych zasad:

<Javascript name='PathSetterPolicy' timeLimit='200'>
    <ResourceURL>jsc://pathSetter.js</ResourceURL>
</Javascript>

Odniesienie do zasady nie może jednoznacznie wskazywać repozytorium. Rozwiązany zostanie pierwszy zasób w najbardziej szczegółowym zakresie, którego nazwa pasuje do nazwy zasobu w zasadach.

Jeśli więc proxy interfejsu API zostanie wdrożone w środowisku prod, zasada zostanie rozpoznana jako zasób pathSetter.js o zakresie środowiska.

Po wdrożeniu w środowisku test zasada zostanie przetłumaczona na zasób o zakresie obejmującym wersję proxy interfejsu API, ponieważ zasób o zakresie obejmującym środowisko znajduje się w środowisku prod, a nie w środowisku test.

Wskazówki dotyczące zasobów Java

Skompilowane zasoby Javy możesz dodać jako pliki JAR, korzystając z różnych opcji w curl, np. opcji -T, --data-binary lub -F (nie opcji -d). Na przykład:

curl "http://{mgmt_server}:{port}/v1/organizations/{org}/environments/{env}/resourcefiles?name={jar_file}&type=java" \
  -X POST \
  --data-binary @{jar_file} \
  -H "Content-Type: application/octet-stream" \
  -u email:password

curl -v "http://{mgmt_server}:{port}/v1/organizations/{org}/environments/{env}/resourcefiles?name={jar_file}&type=java"
  -X POST \
  -H "Content-Type: application/octet-stream" \
  -T "{jar_file}" \
  -u email:password

curl -v "http://{mgmt_server}:{port}/v1/organizations/{org}/environments/{env}/resourcefiles?name={jar_file}&type=java"
  -X POST \
  -H "Content-Type: application/multipart/form-data" \
  -F "file=@{jar_file}" \
  -u email:password

Zobacz też:

• Sprawdzone metody w języku Java: sprawdzone metody projektowania i tworzenia serwerów proxy interfejsu API
• Przykład z książki kucharskiej dotyczącej Javy: zasada przekształcania XSL

Wytyczne dotyczące zasobów Node.js

Gdy odwołujesz się do skryptu Node.js w proxy interfejsu API, robisz to za pomocą elementu <ResourceURL> w konfiguracji TargetEndpoint proxy interfejsu API, jak opisano w artykule Dodawanie Node.js do istniejącego proxy interfejsu API. Na przykład:

<ScriptTarget>
    <ResourceURL>node://hello-world.js</ResourceURL>
</ScriptTarget>

Ten skrypt Node.js i wszystkie moduły pomocnicze muszą znajdować się w zakresie wersji proxy interfejsu API (w katalogu /resources/node pakietu proxy). W edytorze proxy interfejsu API dodaj zasób Node.js do sekcji Skrypty. Dotyczy to również używania interfejsu API (import i update) do przechowywania zasobu w zakresie wersji proxy interfejsu API.

Zarządzanie zasobami za pomocą interfejsu

Zarządzaj zasobami ograniczonymi do wersji proxy interfejsu API za pomocą interfejsu, jak opisano w sekcjach poniżej.

Wyświetlanie zasobów za pomocą interfejsu

Aby wyświetlić zasoby objęte zakresem wersji proxy interfejsu API:

1. Zaloguj się na apigee.com/edge.

2. Na pasku nawigacyjnym po lewej stronie wybierz Develop > API Proxies (Programowanie > Proxy interfejsu API).
3. Na liście wybierz proxy interfejsu API, dla którego chcesz utworzyć zasób.
   Otworzy się edytor proxy interfejsu API, a domyślnie wyświetli się karta Przegląd.
4. Kliknij kartę Develop (Programowanie).
5. W razie potrzeby wybierz wersję z menu Wersja.

   Zasoby objęte zakresem wersji serwera proxy interfejsu API są wymienione w sekcji Zasoby w widoku Nawigator.

   

Tworzenie zasobu za pomocą interfejsu

Aby utworzyć zasoby ograniczone do wersji proxy interfejsu API za pomocą interfejsu użytkownika:

1. Wyświetl zasoby objęte zakresem wersji proxy interfejsu API.
2. W sekcji Zasoby w widoku Nawigator kliknij +, aby otworzyć okno Nowy zasób.
3. Wpisz następujące informacje:

   Pole	Opis
   Źródło	Wybierz, czy chcesz utworzyć nowy plik czy zaimportować plik.
   Typ pliku	Na liście wybierz typ zasobu.
   Nazwa pliku	Nazwa pliku. Rozszerzenie nazwy pliku musi być prawidłowe w przypadku wybranego typu pliku.

Aktualizowanie zasobu za pomocą interfejsu

Aby zaktualizować zasób w zakresie wersji proxy interfejsu API za pomocą interfejsu:

1. Wyświetl zasoby objęte zakresem wersji proxy interfejsu API.
2. W widoku Nawigator w sekcji Zasoby kliknij zasób, który chcesz zaktualizować.
   Uwaga: w przypadku plików JAR umieść kursor nad zasobem, który chcesz edytować, i kliknij .
3. W razie potrzeby zaktualizuj zasób.
   Uwaga: po przesłaniu nowego pliku JAR kliknij Aktualizuj.

Usuwanie zasobu za pomocą interfejsu

Aby usunąć zasób ograniczony do wersji proxy interfejsu API za pomocą interfejsu:

1. Wyświetl zasoby objęte zakresem wersji proxy interfejsu API.
2. W widoku Nawigator w sekcji Zasoby umieść kursor nad zasobem, który chcesz usunąć, aby wyświetlić menu czynności.
3. Kliknij .
4. Aby potwierdzić czynność, kliknij Usuń.

Zarządzanie zasobami za pomocą interfejsu API

Zarządzaj zasobami za pomocą interfejsu API zgodnie z opisem w sekcjach poniżej.

Tworzenie zasobów za pomocą interfejsu API

Utwórz zasoby, które są ograniczone do wersji proxy interfejsu API, środowiska lub organizacji (tylko Edge), zgodnie z opisem w sekcjach poniżej.

Tworzenie zasobów w zakresie wersji proxy interfejsu API za pomocą interfejsu API

Utwórz zasób ograniczony do wersji proxy interfejsu API za pomocą interfejsu API, wysyłając żądanie POST do tego zasobu:https://api.enterprise.apigee.com/v1/organizations/{org}/apis/{api}/revisions/{rev}/resourcefiles

W prośbie podaj te informacje:

• Ustaw parametr zapytania name na nazwę zasobu.
• Ustaw parametr zapytania type na wymagany typ zasobu.
• Przekaż zawartość pliku zasobu jako application/octet-stream lub multipart/form-data).

Poniższy przykład tworzy plik JavaScript o nazwie pathSetter.js dla wersji 1 proxy interfejsu API helloworld:

curl -X POST https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles?name=pathSetter.js&type=jsc
  -H "Content-type:application/octet-stream" \
  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");' \
  -u email:password

Poniższy przykład pokazuje, jak przesłać zasób jako plik z komputera lokalnego. Ważne jest, aby w przypadku przesyłania binarnego w curl używać znaku -F. Dzięki temu pliki JavaScript o zakresie środowiska lub organizacji będą dostępne dla zasad JavaScript.

curl -X POST https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles?name=pathSetter.js&type=jsc
  -H "Content-type:multipart/form-data" \
  -F file=@pathSetter.js \
  -u email:password

Poniżej znajdziesz przykład odpowiedzi z każdego wywołania interfejsu API.

{
  "name": "pathSetter.js",
  "type": "jsc"
}

Więcej informacji znajdziesz w artykule Importowanie pliku zasobów dla wersji serwera proxy interfejsu API.

Możesz też użyć interfejsu API do aktualizowania wersji proxy interfejsu API w ten sposób:

1. Utwórz plik zasobu.
2. Dodaj plik zasobu do pakietu konfiguracji serwera proxy interfejsu API.
3. Prześlij pakiet za pomocą jednego z tych interfejsów API:
   • Tworzenie serwera proxy interfejsu API
   • Aktualizowanie wersji proxy interfejsu API

Tworzenie zasobów w zakresie środowiska za pomocą interfejsu API

Utwórz zasób JavaScript, który jest ograniczony do środowiska, za pomocą interfejsu API, wysyłając żądanie POST do tego zasobu:/organizations/{org}/environments/{env}/resourcefiles

W prośbie podaj te informacje:

• Ustaw parametr zapytania name na nazwę zasobu.
• Ustaw parametr zapytania type na wymagany typ zasobu.
• Przekaż zawartość pliku zasobu jako application/octet-stream lub multipart/form-data).

W poniższym przykładzie pokazujemy, jak utworzyć zasób JavaScript, przekazując jego zawartość w treści żądania.

curl -X POST https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles?name=pathSetter.js&type=jsc
  -H "Content-type:application/octet-stream" \
  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");' \
  -u email:password

Poniższy przykład pokazuje, jak przesłać zasób jako plik z komputera lokalnego. Ważne jest, aby w przypadku przesyłania binarnego w curl używać znaku -F. Dzięki temu pliki JavaScript o zakresie środowiska lub organizacji będą dostępne dla zasad JavaScript.

curl -X POST https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles?name=pathSetter.js&type=jsc
  -H "Content-type:multipart/form-data" \
  -F file=@pathSetter.js \
  -u email:password

Oto przykład odpowiedzi:

{
  "name" : "pathSetter.js",
  "type" : "jsc"
}

Tworzenie zasobów w zakresie organizacji za pomocą interfejsu API

Aby utworzyć zasób ograniczony do organizacji za pomocą interfejsu API, wyślij żądanie POST do tego zasobu:https://api.enterprise.apigee.comv1/organizations/{org}/resourcefiles

W prośbie podaj te informacje:

• Ustaw parametr zapytania name na nazwę zasobu.
• Ustaw parametr zapytania type na typ pliku zasobu (patrz Typy zasobów).
• Przekaż zawartość pliku zasobu jako application/octet-stream lub multipart/form-data).

Więcej informacji znajdziesz w artykule Importowanie pliku zasobów dla organizacji.

Wyświetlanie zasobów za pomocą interfejsu API

W sekcjach poniżej znajdziesz opis wyświetlania zasobów za pomocą interfejsu API.

Wyświetlanie wszystkich zasobów za pomocą interfejsu API

Za pomocą interfejsu API możesz wyświetlać zasoby ograniczone do wersji proxy interfejsu API, środowiska lub organizacji.

Aby na przykład wyświetlić zasoby w zakresie środowiska za pomocą interfejsu API, wyślij żądanie GET do tego zasobu:https://api.enterprise.apigee.com/v1/organizations/{org}/environments/{env}/resourcefiles

Poniższy przykład zawiera listę wszystkich zasobów w środowisku test:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/my-organization/environments/test/resourcefiles/{type}" \
  -u email:password

Poniżej znajdziesz przykład odpowiedzi.

{
  "resourceFile": [
{
  "name" : "pathSetter.js",
  "type" : "jsc"
}
  ]
}

Wyświetlanie zawartości zasobu za pomocą interfejsu API

Wyświetl zawartość zasobu za pomocą interfejsu API zgodnie z opisem w sekcjach poniżej.

Za pomocą interfejsu API możesz wyświetlać zasoby ograniczone do wersji proxy interfejsu API, środowiska lub organizacji.

Aby na przykład wyświetlić zawartość zasobu w środowisku za pomocą interfejsu API, wyślij żądanie GET do tego zasobu:https://api.enterprise.apigee.com/v1/organizations/{org}/environments/{env}/resourcefiles/{type}/name

Poniższy przykład zawiera listę zawartości pliku zasobu JavaScript pathSetter.js w środowisku test:

curl -X GET https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js" \
  -H "Accept: application/json" \
  -u email:password

Oto przykład odpowiedzi:

request.headers["RequestPath"] = context.getVariable("proxy.basepath");

Aktualizowanie zasobów za pomocą interfejsu API

Zaktualizuj zasoby, które są ograniczone do wersji proxy interfejsu API, środowiska lub organizacji (tylko Edge), zgodnie z opisem w kolejnych sekcjach.

Aktualizowanie zasobów objętych zakresem wersji proxy interfejsu API za pomocą interfejsu API

Aby zaktualizować zasób ograniczony do wersji proxy interfejsu API, wyślij żądanie PUT do tego zasobu:https://api.enterprise.apigee.com/v1/organizations/{org}/apis/{api}/revisions/{rev}/resourcefiles/{type}/{name}

Przekaż zawartość pliku zasobu jako application/octet-stream lub multipart/form-data).

Poniższy przykład aktualizuje zasób JavaScript o nazwie pathSetter w wersji 1 proxy interfejsu API helloworld:

curl -X PUT https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles/jsc/pathSetter.js
  -H "Content-type:application/octet-stream" \
  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");' \
  -u email:password

Poniższy przykład pokazuje, jak zaktualizować zasób jako plik z komputera lokalnego. Ważne jest, aby w przypadku przesyłania binarnego w curl używać znaku -F. Dzięki temu pliki JavaScript o zakresie środowiska lub organizacji będą dostępne dla zasad JavaScript.

curl -X PUT https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles/jsc/pathSetter.js
  -H "Content-type:multipart/form-data" \
  -F file=@pathSetter.js \
  -u email:password

Poniżej znajdziesz przykład odpowiedzi z każdego wywołania interfejsu API.

{
  "name": "pathSetter.js",
  "type": "jsc"
}

Więcej informacji znajdziesz w artykule Importowanie pliku zasobów dla wersji serwera proxy interfejsu API.

Możesz też użyć interfejsu API do aktualizowania wersji proxy interfejsu API w ten sposób:

1. Pobierz pakiet konfiguracji serwera proxy interfejsu API za pomocą interfejsu Export API proxy API z tymi opcjami:
   • Ustaw parametr zapytania format na bundle.
   • Ustaw nagłówek Accept na application/zip
2. Zaktualizuj plik zasobów w pakiecie konfiguracji proxy interfejsu API.
3. Prześlij pakiet za pomocą interfejsu API aktualizacji wersji proxy interfejsu API.

Aktualizowanie zasobów w zakresie środowiska za pomocą interfejsu API

Aby zaktualizować zasób, który jest ograniczony do środowiska, użyj interfejsu API i wyślij żądanie PUT do tego zasobu: /organizations/{org}/environments/{env}/resourcefiles/{type}/{name}

Przekaż zawartość pliku zasobu jako application/octet-stream lub multipart/form-data.

Poniższy przykład pokazuje, jak zaktualizować zasób JavaScript, przekazując jego zawartość w treści żądania.

curl -X PUT https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js
  -H "Content-type:application/octet-stream" \
  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");' \
  -u email:password

W przykładzie poniżej pokazujemy, jak zaktualizować plik zasobu za pomocą pliku z komputera lokalnego. Ważne jest, aby w przypadku przesyłania binarnego w curl używać znaku -F. Dzięki temu pliki JavaScript o zakresie środowiska lub organizacji będą dostępne dla zasad JavaScript.

curl -X PUT https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js
  -H "Content-type:multipart/form-data" \
  -F file=@pathSetter.js \
  -u email:password

Oto przykład odpowiedzi:

{
  "name" : "pathSetter.js",
  "type" : "jsc"
}

Aktualizowanie zasobów w organizacji za pomocą interfejsu API

Aby zaktualizować zasób, który jest ograniczony do organizacji, za pomocą interfejsu API, wyślij żądanie POST do tego zasobu:https://api.enterprise.apigee.comv1/organizations/{org}/resourcefiles/{type}/{name}

Przekaż zawartość pliku zasobu jako application/octet-stream lub multipart/form-data).

Więcej informacji znajdziesz w artykule Importowanie pliku zasobów dla organizacji.

Usuwanie zasobów za pomocą interfejsu API

Usuń zasób ograniczony do wersji proxy interfejsu API, środowiska lub organizacji (tylko Edge) zgodnie z opisem w kolejnych sekcjach.

Usuwanie zasobów objętych zakresem wersji proxy interfejsu API za pomocą interfejsu API

Aby usunąć zasób ograniczony do wersji proxy interfejsu API za pomocą interfejsu API, wyślij żądanie DELETE do tego zasobu:https://api.enterprise.apigee.com/v1/organizations/{org}/apis/{api}/revisions/{rev}/resourcefiles/{type}/{name}

Ten przykład usuwa plik zasobu JavaScript pathSetter.js z wersji 1 proxy interfejsu API helloworld:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/my-organization/apis/helloworld/revisions/1/resourcefiles/jsc/pathSetter.js" \
  -u email:password
  

Poniżej znajdziesz przykład odpowiedzi.

{
  "name" : "pathSetter.js",
  "type" : "jsc"
}

Możesz też użyć interfejsu API do aktualizowania wersji proxy interfejsu API w ten sposób:

1. Pobierz pakiet konfiguracji serwera proxy interfejsu API za pomocą interfejsu Export API proxy API z tymi opcjami:
   • Ustaw parametr zapytania format na bundle.
   • Ustaw nagłówek Accept na application/zip
2. Usuń plik zasobu z pakietu konfiguracji proxy interfejsu API.
3. Prześlij pakiet za pomocą interfejsu API aktualizacji wersji proxy interfejsu API.

Usuwanie zasobu ograniczonego do środowiska za pomocą interfejsu API

Usuń zasób ograniczony do środowiska za pomocą interfejsu API, wykonując czynności opisane w sekcjach poniżej.

Aby usunąć zasób ograniczony do środowiska za pomocą interfejsu API, wyślij żądanie DELETE do tego zasobu: https://api.enterprise.apigee.com/v1/organizations/{org}/environments/{env}/resourcefiles/{type}/{name}

W tym przykładzie usuwamy plik zasobu JavaScript pathSetter.js ze środowiska test:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/my-organization/environments/test/resourcefiles/jsc/pathSetter.js" \
  -u email:password

Poniżej znajdziesz przykład odpowiedzi.

{
  "name" : "pathSetter.js",
  "type" : "jsc"
}

Usuwanie zasobów objętych zakresem organizacji za pomocą interfejsu API (tylko Edge)

Aby usunąć zasób, którego zakres jest ograniczony do organizacji, za pomocą interfejsu API, wyślij żądanie DELETE do tego zasobu:https://api.enterprise.apigee.comv1/organizations/{org}/resourcefiles/{type}/{name}

Więcej informacji znajdziesz w artykule Usuwanie pliku zasobu z organizacji.

Uzyskiwanie dostępu do zasobu

Sposób uzyskiwania dostępu do zasobu zależy od typu zasobu. Więcej informacji znajdziesz w dokumentacji dotyczącej odpowiednich zasad.

Przykłady w tej sekcji pokazują, jak utworzyć zasób JavaScript o nazwie pathSetter.js i nim zarządzać, aby można było się do niego odwoływać w zasadach typu JavaScript.

Aby dołączyć JavaScript do funkcji Request PostFlow, utwórz zasadę o nazwie PathSetterPolicy.xml, która odwołuje się do pliku pathSetter.js:

<Javascript name='PathSetterPolicy' timeLimit='200'>
    <ResourceURL>jsc://pathSetter.js</ResourceURL>
</Javascript>

Następnie odwołaj się do zasad w konfiguracji punktu końcowego:

<PostFlow>
  <Request>
    <Step><Name>PathSetterPolicy</Name></Step>
  </Request>
<PostFlow>

Więcej informacji znajdziesz w zasadach dotyczących JavaScriptu.