OhAPI Designer 1.1.1

OhAPI Designer slouží k vytváření, úpravě a ověřování dokumentace rozhraní podle standardu OpenAPI ve verzích 3.0 a 3.1. Systém obsahuje specializovaný textový editor s podporou syntaxe pro formáty JSON a YAML, který je doplněn o mechanismus kontextové nápovědy. Tato funkce analyzuje pozici kurzoru v rámci schématu a navrhuje relevantní klíče a hodnoty, čímž minimalizuje chyby při ručním zápisu specifikací.

Pro zajištění správnosti dokumentů je integrován modul pro průběžnou validaci, který přímo v textu zvýrazňuje neshody se standardem a nabízí detailní popisy chyb. Součástí rozhraní je vizuální panel vlastností, který poskytuje strukturovaný přehled všech definovaných operací, parametrů a odpovědí s možností okamžité navigace k příslušnému kódu. Systém také podporuje rychlou konverzi mezi formáty JSON a YAML při plném zachování obsahu a struktury dokumentu.

Hlavní funkcionality

• Inteligentní doplňování: Navrhování validních parametrů a klíčů OpenAPI na základě aktuálního kontextu a pozice v dokumentu.
• Inline validace: Okamžitá kontrola shody se specifikací se zvýrazněním chyb přímo v editoru a nápovědou pro jejich odstranění.
• Vizuální přehled: Strukturovaná tabulka koncových bodů s barevně odlišenými metodami, parametry a definovanými odpověďmi.
• Navigace odkazů: Schopnost okamžitého přechodu k definicím objektů skrze klikatelné vazby typu $ref v rámci celého souboru.
• Šablony ústřižků: Vkládání předdefinovaných bloků kódu s možností rychlého procházení polí pro doplňování údajů.
• Správa formátů: Plynulý převod mezi datovými strukturami JSON a YAML pro flexibilní práci s různými typy konfiguračních souborů.