Apie OpenAPI / Swagger peržiūros priemonė — Išsamus vadovas
OpenAPI peržiūros priemonė yra kliento pusėje veikianti dokumentacijos skaitytuvė, skirta RESTful API kontraktams nagrinėti. Ji atvaizduoja Swagger 2.0 ir OpenAPI 3.0 / 3.1 specifikacijas JSON arba YAML formatu, nereikalaudama vietinio Swagger UI diegimo ar debesijos priklausomybių.
Ji pateikia tvarkingą sugrupuotą šoninės juostos navigaciją visiems galiniams taškams, rodydama kelius, HTTP metodus (GET, POST, PUT, DELETE), antraščių parametrus, užklausos eilutes, struktūrizuotus užklausos turinius, HTTP atsakymų kodus ir duomenų schemas.
Pagrindinės funkcijos ir galimybės
- Palaiko Swagger 2.0 ir OpenAPI 3.0 / 3.1 specifikacijas JSON bei YAML formatais
- Interaktyvi šoninė juosta, kurioje pateikiami suskirstyti galiniai taškai, HTTP metodai ir būsenos kodai
- Gilus `$ref` schemų išskleidimas, rodantis įdėtinius duomenų modelius ir savybių apribojimus
- 100 % autonominė analizė kliento pusėje, užtikrinanti privačių įmonės API kontraktų saugumą
Kaip naudoti
- 1
Įklijuokite savo `swagger.json` ar `openapi.yaml` tekstą arba tiesiogiai įkelkite specifikacijos failą.
- 2
Naršykite struktūrizuotą API dokumentaciją, pateikiamą interaktyvioje peržiūros priemonėje.
- 3
Išskleiskite bet kurį galinį tašką, kad peržiūrėtumėte užklausos antraštes, užklausos duomenų schemas ir atsakymų pavyzdžius.
Dažniausi naudojimo atvejai
- → Užnugario API apibrėžimų auditas be būtinybės diegti atskirą Swagger UI serverį
- → Ranka rašytų OpenAPI specifikacijų patikra dėl neteisingų `$ref` nuorodų
- → Tikslios schemų dokumentacijos teikimas naudotojo sąsajos programuotojams API integracijų metu
Susiję įrankiai
HTML meta žymų ir SEO generatorius
Generuokite teisingas HTML meta žymas, Open Graph ir Twitter Cards socialiniams tinklams ir paieškai.
Gitignore failų generatorius
Generuokite išsamius .gitignore failus pagal operacinę sistemą, kalbą ir kūrimo įrankį.
Atvirojo kodo licencijų generatorius
Pasirinkite ir generuokite MIT, Apache 2.0, GPL, BSD ir kitas atvirojo kodo licencijas savo projektui.
README failų kūrimo priemonė
Kurkite profesionalius projekto README.md dokumentus su ženkliukais, skiltimis ir instrukcijomis.
Conventional Commits formavimo priemonė
Formatuokite standartizuotus Git commit pranešimus pagal Conventional Commits standartą.
Semver versijų skaičiuotuvas
Apskaičiuokite kitą semantinę versiją (major, minor, patch) ir patikrinkite atitiktį rėžiams.
Dažniausiai užduodami klausimai ir privatumas
Ar šis įrankis gali tiesiogiai nuskaityti YAML specifikacijas?
Taip. Integruotas YAML analizatorius apdoroja tiek `.yaml`, tiek `.json` OpenAPI kontrakto specifikacijas visiškai naršyklėje.
Ar mano privati API specifikacija įkeliama į išorinius serverius?
Ne. Visa dokumento analizė ir schemų atvaizdavimas vykdomi griežtai tik jūsų vietinės naršyklės atmintyje.