Cvičení – odebrání informací hlavičky

  • 10 min

Společnosti, které publikují webová rozhraní API, často potřebují pečlivě řídit hlavičky protokolu HTTP, které jejich rozhraní API vrací, ideálně bez přepisování zdrojového kódu rozhraní API.

Vláda se rozhodla sdílet data sčítání lidu se svými institucemi prostřednictvím rozhraní RESTful API. Důležitými požadavky jsou bezpečné sdílení dat a množnost snadných úprav dat kvůli usnadnění rychlé integrace. Jako vedoucí vývojář musíte vytvořit bránu rozhraní API. Bránu použijete k publikování rozhraní RESTful Census API, které zveřejňuje koncový bod OpenAPI pomocí moderních standardů zabezpečení.

V této části provedete tyto akce:

  • Publikování rozhraní RESTful Census API
  • Nasazení brány služby API Management
  • Zveřejnění rozhraní Census API prostřednictvím koncového bodu brány
  • Odeberte záhlaví z odpovědi.

Důležité

K provedení tohoto cvičení potřebujete vlastní předplatné Azure a mohou se vám účtovat poplatky. Pokud ještě nemáte předplatné Azure, vytvořte si bezplatný účet, než začnete.

Nasazení webového rozhraní API Census

Vyvinuli jste aplikaci .NET Core, která vrací citlivé informace o sčítání lidu. Tato aplikace obsahuje Swashbuckle k vygenerování dokumentace pro OpenAPI.

Abychom ušetřili čas, začněme tím, že spustíme skript pro hostování našeho rozhraní RESTful API v Azure. Skript provede následující kroky:

  • Vytvoří plán služby Azure App Service na úrovni Free.
  • Vytvoří webové rozhraní API v rámci služby Aplikace Azure Service, které je nakonfigurované pro nasazení Gitu z místního úložiště.
  • Nastaví pro naši aplikaci přihlašovací údaje pro nasazení na úrovni účtu.
  • Provede místní konfiguraci Gitu.
  • Nasadí naše webové rozhraní API do instance služby App Service.

  1. Přihlaste se k portálu Azure.

  2. Na hlavním panelu Azure výběrem ikony Cloud Shell otevřete Azure Cloud Shell.

    Screenshot of Cloud Shell icon in taskbar.

  3. Pokud chcete naklonovat úložiště obsahující zdroj pro naši aplikaci, spusťte v Cloud Shellu následující git clone příkaz:

    git clone https://github.com/MicrosoftDocs/mslearn-protect-apis-on-api-management.git

  4. Přejděte místně do složky úložiště spuštěním následujícího příkazu:

    cd mslearn-protect-apis-on-api-management

  5. Jak napovídá název, setup.sh je skript, který spustíte pro vytvoření našeho testovacího rozhraní API. Tento skript vygeneruje veřejnou webovou aplikaci, která zveřejní rozhraní OpenAPI:

    bash setup.sh

    Skript běží přibližně jednu minutu. Až skript skončí, zobrazí dvě adresy URL, které můžete použít k otestování nasazení aplikace. Během nasazení můžete pozorovat, že se na vzdálenou službu App Service automaticky nainstalují všechny závislosti, které jsou potřeba pro běh naší aplikace.

  6. Pokud chcete otestovat správné nasazení aplikace, zkopírujte a vložte první adresu URL z výstupu Cloud Shellu do prohlížeče. Prohlížeč by měl zobrazit uživatelské rozhraní Swaggeru pro naši aplikaci a deklarovat následující koncové body RESTful:

    • api/census, který vrací sčítání lidu a příslušné osoby
    • api/census/{censusYear}, který vrací sčítání lidu a příslušné osoby pro zadaný rok
    • api/people/{reference}, který vrací podrobné informace o konkrétní osobě

    Screenshot of the Swagger page for the API, showing the RESTful endpoints.

  7. Nakonec zkopírujte poslední adresu URL z výstupu Cloud Shellu. Tato adresa URL je adresa URL json swaggeru, kterou budete potřebovat později v tomto cvičení.

Nasazení brány rozhraní API

Dalším krokem v tomto cvičení je vytvoření brány rozhraní API na webu Azure Portal. V další části tuto bránu použijete k publikování rozhraní API:

  1. Přihlaste se k portálu Azure.

  2. V nabídce webu Azure Portal nebo na domovské stránce vyberte Vytvořit prostředek. Zobrazí se podokno Vytvořit prostředek .

  3. V levém podokně nabídek vyberte Integrace a pak do vyhledávacího pole Search a marketplace zadejte API Management. Ve výsledcích vyberte kartu API Management a výběrem možnosti Vytvořit otevřete podokno vytvořit službu API Management.

  4. Na kartě Základy zadejte pro každé nastavení následující hodnoty.

    Nastavení Hodnota
    Podrobnosti projektu
    Předplatné Vyberte své předplatné.
    Skupina prostředků Vyberte novou nebo existující skupinu prostředků. Skupina prostředků je logický kontejner, který obsahuje související prostředky pro řešení Azure.
    Podrobnosti o instanci
    Oblast Vyberte dostupnou oblast.
    Název prostředku Zadejte a nahraďte apim-CensusData<random number>random number vlastní řadou čísel, abyste měli jistotu, že je název globálně jedinečný.
    Název organizace Zadejte Government-Census. Název vaší organizace pro použití na portálu pro vývojáře a e-mailová oznámení (Portál pro vývojáře a oznámení nejsou dostupné ve všech úrovních služby.)
    E-mail správce E-mailová adresa pro příjem všech systémových oznámení.
    Cenová úroveň
    Cenová úroveň Vyberte Consumption (99.95% SLA) z rozevíracího seznamu.

    Screenshot of the completed settings on the Basics tab of the Create API Management service screen.

    Poznámka:

    Úroveň Consumption poskytuje rychlé nasazení pro testování a má cenový model s platbou za použití. Celkové prostředí pro správu rozhraní API je podobné ostatním cenovými úrovněmi.

  5. Vyberte Zkontrolovat a vytvořit. Po úspěšném ověření vyberte Vytvořit. Nasazení může trvat několik minut. Po dokončení nasazení se v prostředcích Azure zobrazí instance služby API Management. Výběrem možnosti Přejít k prostředku zobrazíte podokno služby API Management.

Import rozhraní API

Teď naimportujte rozhraní CENSUS API do brány služby API Management:

  1. V levém podokně nabídek vaší instance služby API Management v části Rozhraní API vybere rozhraní API a pak + Přidat rozhraní API.

  2. V části Vytvořit z definice vyberte OpenAPI. Zobrazí se dialogové okno Vytvořit ze specifikace OpenAPI.

  3. Do pole specifikace OpenAPI vložte adresu URL swagger JSON, kterou jste si uložili dříve ve cvičení.

    Screenshot of the Create from OpenAPI specification dialog box with the swagger JSON URL entered.

    Poznámka:

    Všimněte si, že při odsadíní tabulátoru se některá další pole vyplní za vás. Důvodem je to, že jste použili OpenAPI, který určuje většinu požadovaných podrobností připojení.

  4. U ostatních nastavení ponechte výchozí nastavení a pak vyberte Vytvořit.

Testování rozhraní API

Podívejme se, jaká data se vrací z rozhraní API ve výchozím nastavení:

  1. V nabídce webu Azure Portal nebo na domovské stránce vyberte Všechny prostředky a pak vyberte instanci služby API Management.

  2. V levém podokně nabídek v části Rozhraní API vyberte rozhraní API a v prostředním podokně vyberte Data census.

  3. V horním řádku nabídek vyberte kartu Test a pak vyberte operaci GetLatestCensus .

  4. Vyberte Odeslat.

    Screenshot of the test results for the GetLatestCensus operation, showing the default Response content.

  5. Všimněte si, že v odpovědi se zobrazí x-powered-by a ukazuje, že architektura je ASP.NET.

Odebrání hlaviček

Teď přidáme zásadu pro odebrání hlavičky x-powered-by z odpovědí odeslaných rozhraním API:

  1. Znovu vyberte Census Data a v horním řádku nabídek vyberte kartu Návrh .

  2. Vyberte Všechny operace a v části Odchozí zpracování vyberte <ikonu /> . Zobrazí se editor XML zásad.

    Screenshot of the Design tab with the Policies icon highlighted in the Outbound processing section.

  3. Nahraďte výchozí značku <outbound> tímto kódem:

    <outbound>
   <set-header name="x-powered-by" exists-action="delete" />
   <base />
</outbound>

  4. Zvolte Uložit.

Test odebrání hlaviček

Teď byste měli být schopni spustit test, který ukáže, že hlavičky jsou odebrány:

  1. Znovu vyberte Census Data a v horním řádku nabídek vyberte kartu Test .

  2. Vyberte operaci GetLatestCensus a pak vyberte Odeslat.

    Screenshot of the test results for the GetLatestCensus operation, showing the headers removed in the Response.

  3. Hlavička x-powered-by by neměla být v odpovědi HTTP.