Kurz: Transformace a ochrana rozhraní API

Tento kurz ukazuje, jak transformovat rozhraní API, aby neodhaloval informace o privátním back-endu. Můžete například chtít skrýt informace o zásobníku technologie, který běží na back-endu. Můžete také chtít skrýt původní adresy URL, které se zobrazí v textu odpovědi HTTP rozhraní API, a místo toho je přesměrovat na bránu SLUŽBY APIM.

Tento kurz také ukazuje, jak snadné je přidat ochranu pro back-endové rozhraní API tím, že nakonfigurujete omezení rychlosti pomocí azure API Management. Můžete například chtít omezit rychlost volání rozhraní API, aby vývojáři toto rozhraní API příliš nevyužili. Další informace najdete v tématu API Management zásady.

V tomto kurzu se naučíte:

Požadavky

• Seznamte se s terminologií služby Azure API Management.
• Seznamte se s konceptem zásad ve službě Azure API Management.
• Proveďte následující rychlý start: Vytvoření instance API Management Azure.
• Projděte si také následující kurz: Navíc kurzu: Import a publikování vašeho prvního rozhraní API.

Přejít k instanci služby API Management

1. V Azure Portal vyhledejte a vyberte API Management Services.

   

2. Na stránce API Management služby vyberte svou instanci API Management.

   

Odebrat hlavičky odpovědi transformováním rozhraní API

Tato část ukazuje, jak skrýt hlavičky PROTOKOLU HTTP, které nechcete uživatelům zobrazovat. Tento příklad ukazuje, jak odstranit následující hlavičky v odpovědi HTTP:

• X-Powered-By
• X-AspNet-Version

Test původní odpovědi

Původní odpověď zobrazíte následovně:

1. Ve vaší API Management služby vyberte Rozhraní API.
2. Ze seznamu rozhraní API vyberte Demo Conference API.
3. V horní části obrazovky vyberte kartu Test.
4. Vyberte operaci GetSpeakers a vyberte Odeslat.

Původní odpověď by měla vypadat podobně jako v následujícím příkladu:

Jak vidíte, odpověď obsahuje hlavičky X-AspNet-Version a X-Powered-By.

Nastavení zásady transformací

1. Vyberte Demo Conference API Design All operations ( Všechny > > operace).

2. V části Zpracování odchozích přenosů vyberte ikonu editoru kódu ( </> ).

   

3. Umístěte kurzor do < elementu > outbound a vyberte Zobrazit fragmenty kódu v pravém horním rohu.

4. V pravém okně v části Zásady transformace dvakrát vyberte Nastavit hlavičku PROTOKOLU HTTP (pokud chcete vložit dva fragmenty zásad).

   

5. Upravte kód <outbound> tak, aby vypadal takhle:

   <set-header name="X-Powered-By" exists-action="delete" />
   <set-header name="X-AspNet-Version" exists-action="delete" />
   

   (Nastavit hlavičku HTTP)

6. Vyberte Uložit.

Nahradit původní adresy URL v těle odpovědi rozhraní API adresami URL brány služby APIM

Tato část ukazuje, jak skrýt původní adresy URL, které se zobrazí v textu odpovědi HTTP rozhraní API, a místo toho je přesměrovat na bránu SLUŽBY APIM.

Test původní odpovědi

Původní odpověď zobrazíte následovně:

1. Vyberte Demo Conference API > Test.

2. Vyberte operaci GetSpeakers a vyberte Odeslat.

   Jak vidíte, odpověď obsahuje původní back-endové adresy URL:

   

Nastavení zásady transformací

1. Vyberte Demo Conference API All > operations > Design.
2. V části Zpracování odchozích přenosů vyberte ikonu editoru kódu ( </> ).
3. Umístěte kurzor do < elementu > outbound a vyberte Zobrazit fragmenty kódu v pravém horním rohu.
4. V pravém okně v části Zásady transformace vyberte Mask URLs in content (Maskovat adresy URL v obsahu).
5. Vyberte Uložit.

Ochránit rozhraní API přidáním zásady omezování četnosti (omezení využití sítě)

Tato část ukazuje, jak přidat ochranu back-endovému rozhraní API nakonfigurováním omezování četnosti. Můžete například chtít omezit rychlost volání rozhraní API, aby vývojáři rozhraní API nevyužili příliš. V tomto příkladu je limit nastavený na 3 volání za 15 sekund pro každé ID předplatného. Po 15 sekundách může vývojář zkusit volat rozhraní API znovu.

1. Vyberte Demo Conference API All > operations > Design.

2. V části Zpracování na příchozích přenosech vyberte ikonu editoru kódu ( </> ).

3. Umístěte kurzor do < elementu > inbound a v pravém horním rohu vyberte Zobrazit fragmenty kódu.

   

4. V pravém okně v části Zásady omezení přístupu vyberte + Omezit frekvenci volání na klíč.

5. Upravte kód rate-limit-by-key (v <inbound> elementu ) následujícím kódem:

   <rate-limit-by-key calls="3" renewal-period="15" counter-key="@(context.Subscription.Id)" />
   

Otestovat transformace

Když se v tomto okamžiku podíváte na kód v editoru kódu, vaše zásady vypadají takhle:

<policies>
   <inbound>
     <rate-limit-by-key calls="3" renewal-period="15" counter-key="@(context.Subscription.Id)" />
     <base />
   </inbound>
   <backend>
     <base />
   </backend>
   <outbound>
     <set-header name="X-Powered-By" exists-action="delete" />
     <set-header name="X-AspNet-Version" exists-action="delete" />
     <redirect-content-urls />
     <base />
   </outbound>
   <on-error>
     <base />
   </on-error>
</policies>

Zbývající část článku testuje transformace zásad, které jste nastavili.

Test odebraných hlaviček odpovědi

1. Vyberte Demo Conference API > Test.

2. Vyberte operaci GetSpeakers a vyberte Odeslat.

   Jak vidíte, záhlaví jsou odříznutá:

   

Test nahrazené adresy URL

1. Vyberte Demo Conference API > Test.

2. Vyberte operaci GetSpeakers a vyberte Odeslat.

   Jak vidíte, adresa URL byla nahrazena.

   

Test omezování četnosti (omezení využití sítě)

1. Vyberte Demo Conference API > Test.

2. Vyberte operaci GetSpeakers. Třikrát po sobě vyberte Odeslat.

   Po odeslání požadavku 3krát se vám vyžádá odpověď 429 Příliš mnoho požadavků.

   

3. Počkejte asi 15 sekund a znovu vyberte Odeslat. Tentokrát by se už měla objevit odpověď 200 OK.

Další kroky

V tomto kurzu jste se naučili:

Přejděte k dalšímu kurzu: