Zjišťování a využití rozhraní API

Dokončeno

Zjišťování a spotřeba rozhraní API jsou důležitou součástí používání rozhraní API v celé organizaci.

V této lekci se dozvíte, jak rozšíření API Center VS Code umožňuje snadno zjišťovat a využívat rozhraní API.

Požadavky

Pokud chcete řídit rozhraní API prostřednictvím rozšíření API Center ve VS Code, budete muset:

• Instalace editoru Visual Studio Code
• Nainstalujte rozšíření API Center

Následující rozšíření editoru Visual Studio Code jsou volitelná a potřebná pouze pro určité scénáře, jak je uvedeno:

• Rozšíření klienta REST – pro odesílání požadavků HTTP a zobrazení odpovědí v editoru Visual Studio Code přímo.
• Rozšíření Microsoft Kiota – pro generování klientů rozhraní API

Zjišťování a využití rozhraní API

Katalog rozhraní API vaší organizace můžete zobrazit přímo v editoru Visual Studio Code se všemi vašimi rozhraními API, verzemi, definicemi, prostředími a nasazeními. Díky přehledu okamžitě získáte přehled o všech rozhraních API dostupných ve vaší organizaci.

Ale co když má vaše organizace stovky nebo tisíce rozhraní API? Nemějte obavy, můžete pomocí ikony hledání vyhledat rozhraní API, jak je znázorněno níže.

Zobrazit dokumentaci k rozhraní API

Můžete také rychle získat přístup k dokumentaci k rozhraní API verze Preview a otestovat koncové body pro vaše rozhraní API ve VS Code.

1. Na kartě otevřete rozšíření API Center.
2. Rozbalte stromové zobrazení centra rozhraní API a zobrazte definici rozhraní API.
3. Klikněte pravým tlačítkem myši na definici a vyberte Otevřít dokumentaci k rozhraní API.
4. Zobrazí se nová karta s uživatelským rozhraním Swagger pro definici rozhraní API.
5. Vyberte koncový bod a vyberte Vyzkoušet, zadejte požadované parametry a vyberte Spustit.

Vyzkoušení rozhraní API

S příponou API Center můžete zobrazit soubor .http založený na definici rozhraní API poskytované v Centru rozhraní API. V tomto souboru můžete přímo odesílat požadavky HTTP a zobrazovat odpovědi přímo v editoru.

Poznámka:

Abyste mohli tuto funkci používat, musíte nainstalovat rozšíření REST Client .

1. Rozbalte stromové zobrazení centra rozhraní API a zobrazte definici rozhraní API.
2. Klikněte pravým tlačítkem myši na definici a vyberte Vygenerovat soubor HTTP.
3. Zobrazí se nová karta, která vykreslí dokument .http naplněný specifikací rozhraní API.
4. Pokud chcete vytvořit požadavek, vyberte koncový bod a vyberte Odeslat žádost.

Generování sad SDK

Rozšíření API Center také používá Microsoft Kiota k vygenerování klienta pro vaše rozhraní HTTP REST API pro váš oblíbený jazyk, jak je definováno ve specifikaci OpenAPI. To vám umožní okamžitě generovat klienty pro všechny nebo vybrané koncové body pro vaše rozhraní API, které vyhovují vašim obchodním potřebám.

Poznámka:

Abyste mohli tuto funkci používat, musíte nainstalovat rozšíření Microsoft Kiota .

1. Rozbalte stromové zobrazení centra rozhraní API a zobrazte definici rozhraní API.

2. Klikněte pravým tlačítkem na definici a vyberte Vygenerovat klienta rozhraní API. Zobrazí se podokno Generátor Kiota OpenAPI .

3. Vyberte koncové body rozhraní API a operace HTTP, které chcete zahrnout do sad SDK. Na koncový bod můžete najet myší a výběrem tlačítka +ho přidat nebo odebrat.

4. Po dokončení vyberte tlačítko Přehrát a vygenerujte klienta rozhraní API.

5. Vyberte Vygenerovat klienta rozhraní API.

   a. Zadejte podrobnosti o konfiguraci názvu sady SDK, oboru názvů a výstupním adresáři.

   b) Vyberte jazyk pro vygenerovanou sadu SDK.

Portál Centra rozhraní API v místním prostředí

Portál API Center je web pro vývojáře a zúčastněné strany, aby mohli bezproblémově zjišťovat a zapojovat se s rozhraními API ve vašem inventáři rozhraní API. Díky tomuto webu v místním prostředí poskytují organizace uživatelům webové prostředí pro zjišťování a spotřebu rozhraní API.

Technici platformy API chtějí centralizované a samostatné umístění pro všechny uživatele rozhraní API, a to jak interní, tak i externí. Začněte tím, že použijete úvodní šablonu portálu API Center pomocí následujícího postupu:

Poznámka:

Níže uvedené pokyny jsou určené k nasazení do Azure Static Web Apps, ale můžete ho nasadit ve zvolené infrastruktuře.

1. Vytvořte fork referenčního kódu implementace centra rozhraní API .

2. Vytvořte prostředek statické webové aplikace v Azure.

3. V části Podrobnosti o nasazení vyberte Jako zdroj GitHub a nasměrujte ho do úložiště obsahujícího počáteční kód služby API Center.

4. Static Web Apps rozpozná přednastavení sestavení a naplní React.

5. Zadejte / jako umístění aplikace.

6. Jako výstupní umístění zadejte dist.

7. Vyberte Vytvořit.

   

Zobrazení kódu publikovaného na webu může trvat až 5 minut.

Pokud chcete zobrazit portál API Center spuštěný ve službě Static Web Apps, vyberte Zobrazit aplikaci v prohlížeči na kartě Přehled v prostředku statické webové aplikace, který jste vytvořili na webu Azure Portal.

Konfigurace řízení přístupu na základě role

Správci mají úplnou kontrolu nad přiřazováním oprávnění pro přístup k rozhraním API a prostředkům v centru rozhraní API vaší organizace pomocí řízení přístupu na základě role.

Poznámka:

Ve výchozím nastavení nemají správci centra rozhraní API přístup k rozhraním API na portálu API Center. Nezapomeňte přiřadit roli Čtenář dat ve službě Azure API Center sobě a dalším správcům.

Aby uživatelé měli přístup k rozhraním API v Centru rozhraní API, musí se přihlásit k portálu a musí mít potřebná oprávnění vymezená na centrum rozhraní API. Pokud chcete povolit přihlášení, přiřaďte roli Čtenář dat ve službě Azure API Center uživatelům nebo skupinám ve vaší organizaci podle zde uvedených kroků.