OpenAPI Markdown dokumentáció
OpenAPI vagy Swagger dokumentum átalakítása olvasható Markdown API referencia dokumentációvá.
OpenAPI Markdown dokumentáció
Illessz be egy OpenAPI 3 vagy Swagger 2 dokumentumot — JSON vagy YAML formátumban — és ez az eszköz Markdown API referencia dokumentummá alakítja, amely közvetlenül beilleszthető a README fájlba, wiki oldalra vagy dokumentációs weboldalra. Minden műveleti végpontból önálló szakasz lesz, így a gépi olvasásra szoruló specifikáció könnyen átlátható lesz az csapattársak vagy az új integrálók számára.
A kimenet tartalomjegyzéket tartalmaz, amely az összes csoportra és végpontra mutat, paramétertáblázatot (vagy egyszerű listát) az útvonal-, lekérdezés-, fejléc- és süti-paraméterekhez, generált kérés törzs mintát, egy táblázatot a válaszkódok leírásaival, és egy minta választest az első megfelelő séma alapján. A végpontokat cimkék vagy útvonal szegmensek szerint csoportosíthatja, kiválaszthatja, hogy a kérés minták JSON törzs vagy futásra kész curl parancs formájában jelenjenek meg, és beállíthatja, hogy a végpontfejlécek milyen mélyek legyenek az eredmény meglévő dokumentumba ágyazódjon. Egy váltóval belefoglalhatja vagy kihagyhatja az elavult végpontokat; egy másik elkészíti az összes sémát a komponensek alatt (vagy Swagger definíciói alatt) saját szakaszként a végén.
Az ugyanazon fájlon belüli "$ref" mutatók automatikusan követésre kerülnek paraméterekhez, kérés- és választörzshöz, valamint sémákhoz, így egy komponensekre támaszkodó specifikáció teljes táblázatokat és mintákat hoz létre "$ref" karakterláncok helyett. Más fájlokra vagy URL-ekre mutató hivatkozások változatlanul maradnak, mivel ebben az eszközben soha nem készül hálózati kérés. Ha a generált Markdown meghaladna az eszköz kimeneti korlátját, világos üzenet jelenik meg csatornafagyasztás helyett.
Minden a böngészőben helyileg fut — az API specifikációd, amely gyakran olyan rendszereket írja le, amelyeket nem szeretnél feltárni, soha nem kerül fel sehova. Másolja le a Markdown szöveget, töltse le .txt fájlként, vagy küldje el egy másik eszköznek a további feldolgozáshoz.