Udostępnij za pośrednictwem

Ustawianie parametru ciągu zapytania

  • Artykuł

DOTYCZY: Wszystkie warstwy usługi API Management

Zasady set-query-parameter dodaje, zastępuje wartość lub usuwa parametr ciągu zapytania żądania. Może służyć do przekazywania parametrów zapytania oczekiwanych przez usługę zaplecza, które są opcjonalne lub nigdy nie występują w żądaniu.

Uwaga

Ustaw elementy zasad i elementy podrzędne w kolejności podanej w instrukcji zasad. Aby ułatwić konfigurowanie tych zasad, portal udostępnia edytor oparty na formularzach z przewodnikiem. Dowiedz się więcej na temat ustawiania lub edytowania zasad usługi API Management.

Instrukcja zasad

<set-query-parameter name="param name" exists-action="override | skip | append | delete">
    <value>value</value> <!--for multiple parameters with the same name add additional value elements-->
</set-query-parameter>

Atrybuty

Imię i nazwisko/nazwa opis Wymagani Wartość domyślna
exists-action Określa akcję, która ma zostać wykonana po określeniu parametru zapytania. Ten atrybut musi mieć jedną z następujących wartości.

- override — zastępuje wartość istniejącego parametru.
- skip — nie zastępuje istniejącej wartości parametru zapytania.
- append — dołącza wartość do istniejącej wartości parametru zapytania.
- delete — usuwa parametr zapytania z żądania.

W przypadku ustawienia rejestracji override wielu wpisów o tej samej nazwie powoduje ustawienie parametru zapytania zgodnie ze wszystkimi wpisami (które będą wyświetlane wiele razy); w wyniku zostaną ustawione tylko wymienione wartości.

Wyrażenia zasad są dozwolone.		 Nie. override
name Określa nazwę parametru zapytania, który ma zostać ustawiony. Wyrażenia zasad są dozwolone. Tak Nie dotyczy

Elementy

Nazwa/nazwisko opis Wymagania
wartość Określa wartość parametru zapytania, który ma być ustawiony. W przypadku wielu parametrów zapytania o tej samej nazwie dodaj dodatkowe value elementy. Wyrażenia zasad są dozwolone. Tak

Użycie

  • Sekcje zasad: ruch przychodzący, zaplecze
  • Zakresy zasad: globalny, obszar roboczy, produkt, interfejs API, operacja
  • Bramy: klasyczne, v2, zużycie, self-hosted, obszar roboczy

Przykłady

Ustawianie wartości parametru zapytania


<set-query-parameter name="api-key" exists-action="skip">
  <value>12345678901</value>
</set-query-parameter>

Ustawianie parametru zapytania w celu przekazywania kontekstu do zaplecza

W tym przykładzie pokazano, jak zastosować zasady na poziomie interfejsu API w celu dostarczenia informacji kontekstowych do usługi zaplecza.

<!-- Copy this snippet into the inbound element to forward a piece of context, product name in this example, to the backend service for logging or evaluation -->
<set-query-parameter name="x-product-name" exists-action="override">
  <value>@(context.Product.Name)</value>
</set-query-parameter>

Aby uzyskać więcej informacji, zobacz Wyrażenia zasad i Zmienna kontekstowa.

Powiązana zawartość

Aby uzyskać więcej informacji na temat pracy z zasadami, zobacz: