OpenAPI / Swagger vaataja — Üksikasjalik juhend
OpenAPI vaataja on kliendipoolne dokumentatsiooni lugeja RESTful API lepingute ja spetsifikatsioonide uurimiseks. See renderdab Swagger 2.0 ning OpenAPI 3.0 / 3.1 spetsifikatsioone JSON- või YAML-vormingus ilma kohaliku Swagger UI paigalduse või pilvesõltuvusteta.
Tööriist pakub kõigi lõpp-punktide jaoks selget ja grupeeritud külgriba navigatsiooni, kuvades teekondi, HTTP-meetodeid (GET, POST, PUT, DELETE), päiseparameetreid, päringustringe (query string), struktureeritud päringu kehasid, HTTP-olekukoode ja andmeskeeme.
Põhifunktsioonid ja võimalused
- Toetab Swagger 2.0 ja OpenAPI 3.0 / 3.1 spetsifikatsioone JSON- ja YAML-vormingus
- Interaktiivne külgriba, mis rühmitab lõpp-punktid, HTTP-meetodid ja olekukoodid
- Sügav `$ref` skeemiviidete lahendamine, mis kuvab pesastatud andmemudeleid ja omaduste piiranguid
- 100% kliendipoolne võrguühenduseta parsimine, tagades konfidentsiaalsete ettevõtte API-lepingute turvalisuse
Kuidas kasutada
- 1
Kleebi oma `swagger.json` või `openapi.yaml` tekst või laadi spetsifikatsioonifail otse üles.
- 2
Sirvi interaktiivses vaatajas renderdatud struktureeritud API-dokumentatsiooni.
- 3
Laienda mis tahes lõpp-punkti, et uurida päringupäiseid, päringu sisu skeeme ja näidisvastuseid.
Levinud kasutusjuhud
- → Taustaprogrammi API definitsioonide auditeerimine ilma eraldi Swagger UI serveri seadistamiseta
- → Käsitsi kirjutatud OpenAPI spetsifikatsioonide kontrollimine vigaste `$ref` viidete tuvastamiseks
- → Kliendipoolsetele arendajatele täpsete skeemiviidete pakkumine API integratsioonide ajal
Seotud tööriistad
HTML Meta siltide ja Open Graphi generaator
Genereeri SEO ja sotsiaalmeedia (Open Graph, Twitter Card) meta-silte koos reaalajas eelvaatega.
.gitignore faili generaator
Genereeri optimaalseid .gitignore faile programmeerimiskeeltele, raamistikele ja operatsioonisüsteemidele.
Avatud lähtekoodi litsentsi generaator
Vali ja genereeri populaarseid avatud lähtekoodi tarkvaralitsentse (MIT, Apache 2.0, GPLv3, BSD).
GitHub README.md generaator
Genereeri professionaalseid ja struktureeritud GitHubi projekti README.md faile mallide abil.
Conventional Commits abiline
Loo standardiseeritud Giti commit-sõnumeid vastavalt Conventional Commits spetsifikatsioonile.
SemVer semantilise versioonihalduse kalkulaator
Kontrolli ja võrdle SemVer versioone, arvuta järgmisi versioone ja kontrolli vahemikke.
Korduma kippuvad küsimused ja privaatsus
Kas see tööriist suudab lugeda YAML-spetsifikatsioone otse?
Jah. Sisseehitatud YAML-parser töötleb nii `.yaml` kui ka `.json` OpenAPI lepinguspetsifikatsioone täielikult brauseris.
Kas minu konfidentsiaalne API spetsifikatsioon laaditakse välistesse serveritesse?
Ei. Kogu dokumentide parsimine ja skeemide renderdamine toimub rangelt sinu kohalikus brauseri mälus.