Řízení rozhraní API pomocí rozšíření Azure API Center pro Visual Studio Code
Pokud chcete maximalizovat úspěch úsilí o zásady správného řízení rozhraní API, je důležité v rané fázi vývojového cyklu rozhraní API posunout zásady správného řízení doleva. Tento přístup umožňuje vývojářům rozhraní API správně vytvářet rozhraní API od začátku, ukládat je z plýtvání úsilím o vývoj a zmírnit rozhraní API nesplňující požadavky dále v procesu vývoje.
Rozšíření Azure API Center pro Visual Studio Code obsahuje následující možnosti zásad správného řízení pro vývojáře rozhraní API:
- Vyhodnocení návrhů rozhraní API na základě příruček stylu rozhraní API při vývoji rozhraní API v editoru Visual Studio Code
- Včasné zjišťování zásadních změn, aby rozhraní API zůstala spolehlivá a fungovala podle očekávání a zachovala důvěru koncových uživatelů a zúčastněných stran.
Vývojáři rozhraní API můžou také využívat funkce v rozšíření k registraci rozhraní API v centru rozhraní API a zjišťování a využívání rozhraní API.
Požadavky
Jedno nebo více center rozhraní API ve vašem předplatném Azure.
- V současné době musíte mít přiřazenou roli Přispěvatel služeb Azure API Center nebo vyšší oprávnění v centru rozhraní API ke správě rozhraní API pomocí rozšíření.
- Rozšíření Spectral pro Visual Studio Code – spuštění kontrol souladu s návrhem rozhraní API shift-left v editoru Visual Studio Code
- Optické rozhraní příkazového řádku – detekce zásadních změn mezi dokumenty specifikace rozhraní API
Nastavení
Nainstalujte rozšíření Azure API Center pro Visual Studio Code z webu Visual Studio Code Marketplace. Podle potřeby nainstalujte další rozšíření.
Poznámka:
Pokud je uvedeno, některé funkce jsou k dispozici pouze v předběžné verzi rozšíření Azure API Center. Při instalaci rozšíření z Marketplace editoru Visual Studio Code se můžete rozhodnout nainstalovat verzi nebo předběžnou verzi. Mezi těmito dvěma verzemi můžete kdykoli přepínat pomocí místní nabídky tlačítka Spravovat rozšíření v zobrazení Rozšíření.
V editoru Visual Studio Code na panelu aktivit na levé straně vyberte Centrum rozhraní API.
Pokud nejste přihlášení ke svému účtu Azure, vyberte Přihlásit se k Azure... a podle pokynů se přihlaste. Vyberte předplatné Azure s centrem rozhraní API (nebo centrem rozhraní API), ze kterého chcete zobrazit rozhraní API. Můžete také filtrovat konkrétní předplatná, pokud jich máte mnoho, ze kterých se chcete podívat.
Shoda s návrhem rozhraní API
Pokud chcete zajistit soulad návrhu se standardy organizace při vytváření rozhraní API, poskytuje rozšíření Azure API Center pro Visual Studio Code integrovanou podporu pro lintování specifikace rozhraní API sespectral.
- K otevření palety příkazů použijte klávesovou zkratku Ctrl+Shift+P . Zadejte Azure API Center: Nastavte aktivní průvodce stylem rozhraní API a stiskněte Enter.
- Vyberte jedno z výchozích pravidel, která jsou zadaná, nebo pokud má vaše organizace již k dispozici průvodce stylem, použijte k určení aktivní sady pravidel v editoru Visual Studio Code možnost Vybrat místní soubor nebo vstupní vzdálenou adresu URL . Stiskněte Enter.
Po nastavení aktivního průvodce stylem rozhraní API se otevřením libovolného souboru specifikace založeného na OpenAPI nebo AsyncAPI aktivuje místní operace lintování v editoru Visual Studio Code. Výsledky se zobrazují v editoru i v okně Problémy (Zobrazit>problémy nebo Ctrl+Shift+M).
Detekce zásadních změn
Při zavádění nových verzí vašeho rozhraní API je důležité zajistit, aby změny zavedené nepřerušily uživatele rozhraní API v předchozích verzích vašeho rozhraní API. Rozšíření Azure API Center pro Visual Studio Code usnadňuje detekci zásadních změn u dokumentů specifikace OpenAPI využívajících technologii Optic.
- K otevření palety příkazů použijte klávesovou zkratku Ctrl+Shift+P . Zadejte Azure API Center: Zjištění zásadní změny a stiskněte Enter.
- Vyberte první dokument specifikace rozhraní API, který chcete porovnat. Mezi platné možnosti patří specifikace rozhraní API nalezené v centru rozhraní API, místní soubor nebo aktivní editor v editoru Visual Studio Code.
- Vyberte druhý dokument specifikace rozhraní API, který chcete porovnat. Mezi platné možnosti patří specifikace rozhraní API nalezené v centru rozhraní API, místní soubor nebo aktivní editor v editoru Visual Studio Code.
Visual Studio Code otevře rozdílové zobrazení mezi dvěma specifikacemi rozhraní API. Všechny zásadní změny se zobrazí v editoru i v okně Problémy (Zobrazit>problémy nebo Ctrl+Shift+M).
Související obsah
- Azure API Center – klíčové koncepty
- Sestavení a registrace rozhraní API pomocí rozšíření Azure API Center pro Visual Studio Code
- Zjišťování a využívání rozhraní API pomocí rozšíření Azure API Center pro Visual Studio Code
- Povolení a zobrazení katalogu rozhraní API platformy v editoru Visual Studio Code