Internetinis JSON SchemakonverterisOpenAPI
Duomenų modelių perkėlimas tarp skirtingų standartų gali būti varginanti rankinė užduotis. Mūsų „ JSON Schemato OpenAPIConverter“ automatizuoja šį procesą, leisdama jums akimirksniu konvertuoti standartinius JSON Schemaapibrėžimus į OpenAPIspecifikacijas(OAS) suderinamus formatus. Nesvarbu, ar kuriate „Swagger“ dokumentaciją, ar apibrėžiate užklausų / atsakymų tekstus, šis įrankis užtikrina tikslumą ir atitiktį reikalavimams.
Kodėl verta konvertuoti JSON Schemaį OpenAPI?
Nors OpenAPI(anksčiau „Swagger“) naudoja pogrupį JSON Schema, yra esminių skirtumų, kaip tam tikri raktiniai žodžiai, pvz. type, nullable, ir, formatyra tvarkomi skirtingose versijose(4, 7 juodraštis arba 2019-09) ir OpenAPI3.0/3.1 specifikacijose.
Suderinamumo spragos užpildymas
OpenAPI3.0 versija turi specifinių apribojimų, kurie skiriasi nuo standartinių JSON Schema. Mūsų konverteris tvarko šiuos niuansus, pvz., konvertuoja dependenciesį suderinamą logiką arba koreguoja typemasyvus, kad jie atitiktų OpenAPIgriežtus reikalavimus, užtikrindamas, kad jūsų API dokumentacija išliktų galiojanti.
Supaprastinkite API kūrimą
Užuot perrašę savo duomenų bazių modelius ar API dokumentų patvirtinimo schemas, galite tiesiog įklijuoti esamus JSON Schema. Tai sumažina žmogiškųjų klaidų skaičių ir užtikrina, kad jūsų vidinės sistemos logika ir dokumentacija būtų puikiai sinchronizuoti.
Pagrindinės mūsų keitiklio savybės
Mūsų įrankis skirtas kūrėjams, kuriems reikia tikslumo ir greičio tvarkant API specifikacijas.
JSON Schema1. Kelių juodraščių palaikymas
Nesvarbu, ar jūsų šaltinio schema pagrįsta 4, 7 ar 2020-12 juodraščiu, mūsų variklis identifikuoja struktūrą ir susieja ją su artimiausiu OpenAPIatitikmeniu.
2. OpenAPI3.0 ir 3.1 paruoštas
OpenAPI3.1 versija dabar visiškai suderinama su JSON Schema2019–2019 m. versija. Tačiau, jei vis dar naudojate OpenAPI3.0 versiją, mūsų įrankis automatiškai „pažemins“ tam tikrus laukus(pvz., nullable: truevietoj type: ["string", "null"]), kad būtų išlaikytas suderinamumas.
3. Momentinis patvirtinimas ir formatavimas
Jis ne tik konvertuoja duomenis, bet ir pagražina išvestį. Gausite švarią, įtrauktą ir galiojančią OpenAPIschemą, kurią galėsite įklijuoti į savo components/schemasskyrių.
Kaip naudoti keitiklį
Įklijuokite kodą: nukopijuokite šaltinį JSON Schemaį įvesties redaktorių.
Pasirinkite versiją(neprivaloma): pasirinkite, ar norite, kad išvestis būtų optimizuota OpenAPI3.0 ar naujesniam 3.1 standartui.
Spustelėkite „Konvertuoti“: įrankis apdoros logiką ir išvesties lange parodys su „OpenAPI“ suderinamą rezultatą.
Kopijuoti ir naudoti: Norėdami paimti naują schemą savo „Swagger“ arba „Redocly“ dokumentacijai, naudokite mygtuką „Kopijuoti“.
Techniniai skirtumai, į kuriuos reikia atkreipti dėmesį
„Nullable“ savybės tvarkymas
Standartiškai JSON Schemanulinės vertės laukas dažnai apibrėžiamas kaip type: ["string", "null"]. OpenAPI3.0 versijoje tai turi būti konvertuojama į type: stringnaudojant atskirą nullable: truesavybę. Mūsų konverteris tai atlieka automatiškai.
Raktinis žodis „formatas“
OpenAPIplačiau naudoja formatraktinį žodį patvirtinimui(pvz. int32, int64, float, double). Mūsų įrankis užtikrina, kad šie formatai būtų išsaugoti ir teisingai susieti transformacijos metu.
Dažnai užduodami klausimai(DUK)
Ar šis konverteris suderinamas su „Swagger 2.0“?
Nors dėmesys sutelktas į OpenAPI3.x versiją, sugeneruotos schemos iš esmės suderinamos su „Swagger 2.0“, nors definitionsgali prireikti tam tikrų skyriaus pakeitimų.
Ar mano duomenys palieka naršyklę?
Ne. Visa konvertavimo logika vyksta lokaliai jūsų naršyklėje naudojant „JavaScript“. Jūsų slaptos API schemos niekada nesiunčiamos į mūsų serverius.
Ar galiu konvertuoti dideles, sudėtingas schemas?
Taip. Mūsų įrankis yra optimizuotas apdoroti giliai įdėtas schemas ir didelius objektų apibrėžimus be našumo sulėtėjimo.