Kurz: napodobení odpovědí rozhraní API
Back-endové rozhraní API je možné importovat do rozhraní API pro API Management (APIM) nebo je vytvořit a spravovat ručně. V krocích v tomto kurzu se dozvíte, jak pomocí APIM vytvořit prázdné rozhraní API a ručně ho spravovat, a pak nastavit zásadu na rozhraní API tak, aby vracela napodobnou odpověď. Tato metoda umožňuje vývojářům pokračovat v implementaci a testování instance služby APIM i v případě, že není k dispozici back-end, který by odesílal skutečné odpovědi.
Možnost napodobení odpovědí může být užitečná v různých scénářích:
- Když se jako první navrhuje fasáda rozhraní API a back-endová implementace proběhne později. Případně vývoj back-endu probíhá paralelně.
- Když back-end dočasně není v provozu nebo neumožňuje škálování.
V tomto kurzu se naučíte:
- Vytvoření testovacího rozhraní API
- Přidání operace do testovacího rozhraní API
- Povolení napodobování odpovědí
- Test imitace rozhraní API
Požadavky
- Seznamte se s terminologií služby Azure API Management.
- Seznamte se s konceptem zásad ve službě Azure API Management.
- Dokončete následující rychlý Start: vytvoření instance služby Azure API Management.
Vytvoření testovacího rozhraní API
Postup v této části ukazuje, jak vytvořit prázdné rozhraní API bez jakéhokoli back-endu.
Přihlaste se k Azure Portal a přejděte k instanci API Management.
Vyberte rozhraní API > + Přidat rozhraní API > prázdné rozhraní API.
V okně vytvořit prázdné rozhraní API vyberte plná.
Zadejte testovací rozhraní API pro zobrazované jméno.
Pro produkty vyberte neomezeno .
Zajistěte, aby byl v bráně vybraný spravovaný .
Vyberte Vytvořit.
Přidání operace do testovacího rozhraní API
Rozhraní API zpřístupňuje jednu nebo více operací. V této části přidejte operaci do prázdného rozhraní API, které jste vytvořili. Zavolání operace po dokončení kroků v této části způsobí chybu. Po dokončení kroků později v části povolení napodobení odpovědi se nezobrazí žádné chyby.
Vyberte rozhraní API, které jste vytvořili v předchozím kroku.
Vyberte + Přidat operaci.
V okně front-end zadejte následující hodnoty.
Nastavení Hodnota Popis Zobrazovaný název Test call Název, který se zobrazí na portálu pro vývojáře. Adresa URL (příkaz HTTP) GET Vyberte jeden z předdefinovaných příkazů HTTP. Adresa URL /test Cesta URL k rozhraní API. Popis Nepovinný popis operace, který se používá k poskytnutí dokumentace na portálu pro vývojáře vývojářům pomocí tohoto rozhraní API. Vyberte kartu odpovědi , která se nachází pod poli Adresa URL, zobrazovaný název a popis. Zadáním nastavení na této kartě můžete definovat stavové kódy odpovědí, typy obsahu, příklady a schémata.
Vyberte + Přidat odpověď a v seznamu vyberte 200 OK .
Pod záhlavím Reprezentace na pravé straně vyberte + Přidat reprezentaci.
Do vyhledávacího pole zadejte Application/JSON a vyberte typ obsahu Application/JSON .
Do textového pole Ukázka zadejte
{ "sampleField" : "test" }.Vyberte Uložit.
I když se v tomto příkladu nevyžaduje, další nastavení pro operaci rozhraní API můžete nakonfigurovat na dalších kartách, včetně těchto:
| Karta | Popis |
|---|---|
| Dotaz | Přidejte parametry dotazu. Kromě zadání názvu a popisu můžete zadat hodnoty, které jsou přiřazeny parametru dotazu. Jedna z hodnot může být označená jako výchozí (volitelné). |
| Žádost | Definujte typy obsahu, příklady a schémata požadavku. |
Povolení napodobování odpovědí
Vyberte rozhraní API, které jste vytvořili v části Vytvoření testovacího rozhraní API.
Vyberte testovací operaci, kterou jste přidali.
V okně na pravé straně se ujistěte, že je vybraná karta Návrh .
V okně příchozí zpracování vyberte + Přidat zásadu.
Z Galerie vyberte přípravou odezvu .
Do textového pole Odpověď služby API Management zadejte 200 OK, application/json. Tento výběr určuje, že by vaše rozhraní API mělo vracet ukázku odpovědi, kterou jste definovali v předchozí části.
Vyberte Uložit.
Tip
Žlutý pruh s napsaným textem je pro vaše rozhraní API k dispozici, což znamená, že odpovědi vrácené z API Management jsou vytvářené pomocí zásad pro napodobování a nejsou vytvářeny back-end.
Test imitace rozhraní API
Vyberte rozhraní API, které jste vytvořili v části Vytvoření testovacího rozhraní API.
Vyberte kartu Test.
Ujistěte se, že je vybrané rozhraní API Test call. Vyberte Odeslat a proveďte testovací volání.
V odpovědi HTTP se zobrazí JSON zadaný jako ukázka v první části tohoto kurzu.
Další kroky
V tomto kurzu jste se naučili:
- Vytvoření testovacího rozhraní API
- Přidání operace do testovacího rozhraní API
- Povolení napodobování odpovědí
- Test imitace rozhraní API
Přejděte k dalšímu kurzu: