OpenAPI v dokumentacijo Markdown
Pretvorite OpenAPI ali Swagger dokument v berljivo Markdown referenčno dokumentacijo API-ja.
OpenAPI v dokumentacijo Markdown
Prilepite OpenAPI 3 ali Swagger 2 dokument — JSON ali YAML — in to orodje ga pretvori v Markdown referenčno dokumentacijo API-ja, ki jo lahko direktno vključite v README, wiki stran ali dokumentacijo. Vsaka operacija postane svojski razdelek, zato je specifikacija, ki jo lahko bere samo stroj, nešto, kar lahko kolega ali novi integrator hitro pregleda.
Izhod vključuje kazalo vsebine s povezavami na vsako skupino in končno točko, tabelo parametrov (ali navaden seznam) za pot, poizvedbo, glavo in piškotek parametre, ustvarjen vzorec telesa zahtevka, tabelo kod odgovorov z opisi in primer telesa odgovora iz prve ujemajoče se sheme. Grupirajte končne točke po oznaki ali po prvem segmentu njihove poti, izberite, ali se vzorci zahtevkov prikazujejo kot JSON telo ali kot pripravljen curl ukaz, in izberite, kako globoko se naslovi končnih točk pojavljajo, tako da se rezultat ugnezdi v obstoječi dokument. Ena preglednica vključuje ali preskoči zastarele končne točke; druga izpis vsake sheme pod komponentami (ali Swagger-ove definicije) kot svojski razdelek na koncu.
Reference "$ref" znotraj iste datoteke se sledijo za parametre, telesa zahtevkov in odgovorov ter sheme, tako da specifikacija, ki se opira na komponente, še vedno ustvari polne tabele in vzorce namesto gole $ref navidezne besede. Reference v drugo datoteko ali URL ostanejo nespremenjene, ker se tukaj nikoli ne naredi omrežnega zahtevka. Če generirani Markdown presega mejno vrednost izhoda orodja, dobite jasno sporočilo namesto zmrznjene zavihka.
Vsega se izvaja lokalno v vašem brskalniku — vaša specifikacija API-ja, ki pogosto opisuje sisteme, ki jih ne želite izpostaviti, se nikoli ne pošlje nikamor. Kopirajte Markdown, ga prenesite kot .txt datoteko ali ga pošljite drugemu orodju, da nadaljujete s predelavo.