Ruční přidání rozhraní API

PLATÍ PRO: Všechny úrovně služby API Management

Tento článek ukazuje, jak ručně přidat rozhraní API do služby Azure API Management. Když chcete vytvořit napodobené odpovědi z rozhraní API, můžete vytvořit prázdné rozhraní API. Informace o vytváření napodobených odpovědí rozhraní API najdete v tématu Napodobení odpovědí rozhraní API.

Pokud chcete importovat existující rozhraní API, přečtěte si část Související obsah tohoto článku.

V tomto článku se dozvíte, jak vytvořit prázdné rozhraní API. Jako back-endové rozhraní API zadáte httpbin.org (veřejná testovací služba).

Požadavky

• Dokončete rychlý úvod ke vytvoření instance služby Azure API Management.

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

1. Na portálu Azure vyhledejte a vyberte služby API Management:

   

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

   

Vytvoření rozhraní API

1. V části Rozhraní API v nabídce vlevo vyberte rozhraní API.

2. Vyberte + Přidat rozhraní API.

3. Vyberte dlaždici HTTP:

   

4. Zadejte adresu URL webové služby backendu (například https://httpbin.org) a další nastavení pro rozhraní API. Nastavení jsou vysvětlena v tutoriálu Import a publikování vašeho prvního rozhraní API.

5. Vyberte Vytvořit.

V tuto chvíli nemáte žádné operace v API Managementu, které mapují na operace ve vašem back-endovém API. Zavoláte-li operaci dostupnou přes back-end, ale ne přes API Management, zobrazí se chyba 404.

Poznámka:

Když ve výchozím nastavení přidáte rozhraní API, i když je připojené k back-endové službě, služba API Management nezpřístupní žádné operace, dokud je nepovolíte. Pokud chcete povolit operaci vaší backendové služby, vytvořte operaci v API Managementu, která se mapuje na backendovou operaci.

Přidání a otestování operace

Tato část ukazuje, jak přidat /get operaci, která ji namapuje na back-endovou http://httpbin.org/get operaci.

Přidání operace

1. Vyberte rozhraní API, které jste vytvořili v předchozím kroku.
2. Vyberte + Přidat operaci.
3. V adrese URL vyberte GET a do textového pole zadejte /get .
4. Do pole Zobrazovaný název zadejte FetchData.
5. Zvolte Uložit.

Otestování operace

Otestujte operaci na portálu Azure Portal. (Můžete ho také otestovat na portálu pro vývojáře.)

1. Vyberte kartu Test.
2. Vyberte FetchData.
3. Vyberte Odeslat.

Odpověď, kterou operace http://httpbin.org/get vygeneruje, se zobrazí v části odpovědi HTTP . Pokud své operace chcete transformovat, přečtěte si téma Transformace a ochrana vašeho rozhraní API.

Přidání a otestování parametrizované operace

V této části se dozvíte, jak přidat operaci, která má parametr. V tomto příkladu namapujete operaci na http://httpbin.org/status/200.

Přidání operace

1. Vyberte rozhraní API, které jste vytvořili dříve.
2. Na kartě Návrh vyberte + Přidat operaci.
3. V adrese URL vyberte GET a do textového pole zadejte /status/{code} .
4. Do pole Zobrazovaný název zadejte GetStatus.
5. Zvolte Uložit.

Otestování operace

Otestujte operaci na portálu Azure Portal. (Můžete ho také otestovat na portálu pro vývojáře.)

1. Vyberte kartu Test.

2. Vyberte GetStatus. Do kódu zadejte 200.

3. Vyberte Odeslat.

   Odpověď, kterou operace http://httpbin.org/status/200 vygeneruje, se zobrazí v části odpovědi HTTP . Pokud své operace chcete transformovat, přečtěte si téma Transformace a ochrana vašeho rozhraní API.

Přidejte a otestujte operaci se zástupným znakem

Tato část ukazuje, jak přidat operaci se zástupným znakem. Operace se zástupným znakem umožňuje předat libovolnou hodnotu v rámci požadavku prostřednictvím rozhraní API. Místo vytváření samostatných operací GET, jak je znázorněno v předchozích částech, můžete vytvořit operaci GET se zástupným znakem.

Upozornění

Při konfiguraci operace se zástupným znakem buďte opatrní. Díky této konfiguraci může být rozhraní API zranitelnější vůči určitým hrozbám zabezpečení rozhraní API.

Přidání operace

1. Vyberte rozhraní API, které jste vytvořili dříve.
2. Na kartě Návrh vyberte + Přidat operaci.
3. V adrese URL vyberte GET a do textového pole zadejte /*.
4. Do pole Zobrazovaný název zadejte WildcardGet.
5. Zvolte Uložit.

Otestování operace

Otestujte operaci na portálu Azure Portal. (Můžete ho také otestovat na portálu pro vývojáře.)

1. Vyberte kartu Test.

2. Vyberte WildcardGet. Vyzkoušejte operace GET, které jste otestovali v předchozích částech, nebo zkuste jinou podporovanou operaci GET.

   Například v parametrech šablony změňte hodnotu vedle názvu zástupných znaků (*) na záhlaví. Operace vrátí hlavičky HTTP příchozího požadavku.

3. Vyberte Odeslat.

   Odpověď, kterou operace http://httpbin.org/headers vygeneruje, se zobrazí v části odpovědi HTTP . Pokud své operace chcete transformovat, přečtěte si téma Transformace a ochrana vašeho rozhraní API.

Poznámka:

Je důležité pochopit, jak hostitel rozhraní API pro backend, se kterým se integrujete, zachází s případnými lomítky na konci adresy URL operace. Další informace najdete v nejčastějších dotazech ke službě API Management.

Připojení dalších rozhraní API

Můžete vytvořit rozhraní API z rozhraní API, která jsou poskytovaná různými službami, včetně:

• Specifikace OpenAPI
• Rozhraní API SOAP
• Rozhraní GraphQL API
• Webová aplikace hostovaná ve službě Azure App Service
• Azure Functions
• Azure Logic Apps
• Azure Service Fabric

Poznámka:

Při importu rozhraní API se operace připojí k aktuálnímu rozhraní API.

Připojení API k existujícímu API:

1. Na webu Azure Portal přejděte do své instance služby Azure API Management:

   

2. Na stránce přehledu vyberte rozhraní API nebo v nabídce vlevo vyberte rozhraní API>.

   

3. Vyberte ikonu se třemi tečkami (...) vedle rozhraní API, k němuž chcete přidat další rozhraní API.

4. V rozevírací nabídce vyberte Importovat:

   

5. Vyberte službu, ze které se má importovat rozhraní API.

Související obsah

• Omezení importu rozhraní API
• Importujte OpenAPI specifikaci
• Importovat SOAP API
• Import rozhraní SOAP API a jeho převod na rozhraní REST
• Importování API služby App Service
• Importujte API aplikace kontejneru
• Import rozhraní WEBSocket API
• Importujte GraphQL API
• Import schématu GraphQL a nastavení překladačů polí
• Importujte rozhraní API funkční aplikace
• Import rozhraní API aplikace logiky
• Importovat službu Service Fabric
• Importujte API Azure AI Foundry rozhraní
• Importujte rozhraní API Azure OpenAI
• Import rozhraní LLM API
• Import OData API
• Exportujte REST API jako MCP server
• Zveřejnění existujícího serveru MCP
• Import rozhraní API agenta A2A
• Import metadata SAP OData
• Importujte rozhraní API gRPC
• Úprava rozhraní API