OpenAPI na dokumentaci Markdown
Převeďte dokument OpenAPI nebo Swagger na čitelnou referenční dokumentaci API v Markdown.
OpenAPI na dokumentaci Markdown
Vložte dokument OpenAPI 3 nebo Swagger 2 — JSON nebo YAML — a tento nástroj jej převede na referenční dokumentaci API v Markdown, kterou můžete vložit přímo do README, wiki stránky nebo webu dokumentace. Každá operace se stane vlastní sekcí, takže specifikace, kterou by mohla snadno číst pouze máquina, se stane něčím, co si kolegové nebo noví integralisté mohou rychle přehlédnout.
Výstup obsahuje obsah s odkazy na jednotlivé skupiny a koncové body, tabulku parametrů (nebo jednoduchý seznam) pro parametry cesty, dotazu, záhlaví a cookies, vytvořenou ukázku těla požadavku, tabulku kódů odpovědí s jejich popisem a příkladnou odpověď z prvního odpovídajícího schématu. Seskupte koncové body podle tagu nebo podle prvního segmentu jejich cesty, vyberte si, zda se ukázky požadavků mají zobrazit jako tělo JSON nebo jako spustitelný příkaz curl, a nastavte hloubku nadpisů koncových bodů tak, aby byl výsledek vnořen do existujícího dokumentu. Jeden přepínač zahrnuje nebo přeskakuje zastaralé koncové body; další vypíše každé schéma pod komponentami jako vlastní sekci na konci.
Odkazy "$ref" v rámci stejného souboru se automaticky sledují pro parametry, těla požadavků a odpovědí a schémata, takže specifikace, která se opírá o komponenty, stále produkuje úplné tabulky a ukázky místo holých řetězců $ref. Odkazy na jiný soubor nebo URL jsou ponechány bez změny, protože tento nástroj nikdy nedosahuje mimo prohlížeč. Pokud by vygenerovaný Markdown překročil limit výstupu nástroje, zobrazí se vám jasná zpráva místo zasekaného záložky.
Všechno se spouští lokálně ve vašem prohlížeči — vaše specifikace API, která často popisuje systémy, které nechcete odhalit, není nikdy nikam nahrána. Zkopírujte Markdown, stáhněte si jej jako soubor .txt nebo jej pošlete dalšímu nástroji, abyste na něm mohli pokračovat.