Vytvoření brány rozhraní API

Dokončeno

Organizace často potřebují poskytnout partnerům přístup k datům. Tento přístup musí být řízený a spravovaný.

V příkladu obuvnické společnosti potřebují prodejci bot NorthWind Shoes vědět, jak velkou objednávku mohou udělat. Zákazníci také rádi přesně vědí, kdy budou dostávat svoji objednávku.

Tady se dozvíte, jak azure API Management funguje a jak nastavit bránu rozhraní API.

Azure API Management

Služba Azure API Management je hostovaná v cloudu Azure a je umístěná mezi vašimi rozhraními API a internetem. Vaše instance služby API Management funguje jako brána rozhraní API Azure.

Při publikování rozhraní API používáte web Azure Portal k řízení toho, jakým způsobem se konkrétní rozhraní API zveřejňují spotřebitelům. Můžete chtít, aby některá rozhraní API byla volně přístupná vývojářům pro ukázkové účely a aby přístup k jiným rozhraním API byl přísně řízený.

Proč používat Azure API Management?

Vývojářům poskytuje API Management řadu výhod.

  • Dokumentace rozhraní API. Dokumentace rozhraní API umožňuje volajícím klientům rychle integrovat jejich řešení. Api Management umožňuje rychle zveřejnit strukturu rozhraní API pro volání klientů prostřednictvím moderních standardů, jako je OpenAPI. Můžete mít více než jednu verzi rozhraní API. S více verzemi si můžete připravit aktualizace aplikací, protože vaše uživatelské aplikace nemusí používat novou verzi okamžitě.
  • Přístup s omezením rychlosti. Pokud by vaše rozhraní API mohlo potenciálně přistupovat k velkému objemu dat, je vhodné omezit rychlost, jakou mohou klienti vyžadovat data. Omezení rychlosti pomáhá udržovat optimální doby odezvy pro všechny klienty. Služba API Management umožňuje nastavit omezení rychlosti jako celek nebo pro konkrétní jednotlivé klienty.
  • Monitorování stavu. Vzdálení klienti využívají vaše rozhraní API, takže může být obtížné identifikovat potenciální problémy nebo chyby. API Management vám umožní zobrazit chybové odpovědi a soubory protokolů a filtrovat podle typů odpovědí.
  • Moderní formáty jako JSON. V průběhu let používala rozhraní API z XML na CSV mnoho různých formátů výměny dat a mnoho dalších. API Management umožňuje tyto formáty zveřejnit pomocí moderních datových modelů, jako je JSON.
  • Připojení k libovolnému rozhraní API. V mnoha firmách se rozhraní API nacházejí v různých zemích nebo oblastech a používají různé formáty. Služba API Management umožňuje přidat všechna tato různorodá rozhraní API do jednoho moderního rozhraní.
  • Analýza. Při vývoji rozhraní API je užitečné vidět, jak často se vaše rozhraní API volají a jaké typy systémů je volají. API Management umožňuje vizualizovat tato data na webu Azure Portal.
  • Zabezpečení. Při práci se systémovými daty je zabezpečení na prvním místě. Neoprávněná porušení zabezpečení mohou stát společnost peníze, čas ztracený při přepracování kódu a také pověst. Mezi nástroje zabezpečení, které můžete použít se službou Azure API Management, patří autorizace uživatelů OAuth 2.0 a integrace s Microsoft Entra ID.
  • Cenové úrovně. Api Management nabízí úrovně s různými možnostmi pro propustnost požadavků, smlouvu o úrovni služeb (SLA), izolaci sítě, flexibilitu upgradu atd. Když vytvoříte bránu služby Azure API Management, zvolíte úroveň, která vyhovuje vašim potřebám.

Nastavení API Managementu

Pokud chcete nastavit API Management:

  1. Vytvořte bránu API Managementu. Název, který pro bránu používáte, musí být globálně jedinečný v rámci oboru názvů .azure-api.net.
  2. Zaregistrujte existující webové rozhraní API v bráně. Registrace rozhraní API zpřístupňuje rozhraní API uživatelům v koncovém bodu <brány>.azure-api.net.
  3. Stávající rozhraní API můžete volat skrz bránu. Uživatelé teď můžou rozhraní API volat na adrese URL koncového bodu.