Mtandaoni JSON Schemahadi OpenAPIKibadilishaji
Kuhamisha mifumo yako ya data kati ya viwango tofauti kunaweza kuwa kazi ngumu ya mwongozo. Kibadilishaji chetu JSON Schemacha OpenAPIdata huendesha mchakato huu kiotomatiki, na kukuruhusu kubadilisha JSON Schemaufafanuzi sanifu kuwa miundo inayolingana na OpenAPIVipimo(OAS) mara moja. Iwe unaunda nyaraka za Swagger au unafafanua miili ya ombi/majibu, chombo hiki kinahakikisha usahihi na uzingatiaji.
Kwa nini ubadilishe JSON Schemakuwa OpenAPI?
Ingawa OpenAPI(zamani Swagger) hutumia sehemu ndogo ya JSON Schema, kuna tofauti kubwa katika jinsi maneno muhimu fulani kama type, nullable, na formatyanavyoshughulikiwa kati ya matoleo tofauti(Rasimu ya 4, 7, au 2019-09) na OpenAPIvipimo vya 3.0/3.1.
Kuziba Pengo la Utangamano
OpenAPI3.0 ina vikwazo maalum ambavyo hutofautiana na kiwango JSON Schema. Kibadilishaji chetu hushughulikia nuances hizi, kama vile kubadilisha dependencieshadi mantiki inayolingana au kurekebisha typesafu ili kukidhi OpenAPImahitaji madhubuti, kuhakikisha hati zako za API zinabaki kuwa halali.
Kurahisisha Uundaji wa API
Badala ya kuandika upya mifumo yako ya hifadhidata au mipango ya uthibitishaji kwa hati zako za API, unaweza kubandika tu faili zako zilizopo JSON Schema. Hii hupunguza makosa ya kibinadamu na huweka mantiki na nyaraka zako za nyuma zikiwa zimesawazishwa kikamilifu.
Vipengele Muhimu vya Kibadilishaji Chetu
Zana yetu imeundwa kwa ajili ya wasanidi programu wanaohitaji usahihi na kasi wanapodhibiti vipimo vya API.
1. Usaidizi wa JSON SchemaRasimu Nyingi
Ikiwa mpango wako wa chanzo unategemea Rasimu ya 4, 7, au 2020-12, injini yetu hutambua muundo na kuuweka kwenye ramani ya OpenAPIsawa zaidi.
2. OpenAPI3.0 & 3.1 Tayari
OpenAPI3.1 sasa inaendana kikamilifu na JSON Schema2019-09. Hata hivyo, ikiwa bado unatumia OpenAPI3.0, zana yetu "itashusha kiwango" kiotomatiki sehemu maalum(kama nullable: truebadala ya type: ["string", "null"]) ili kudumisha utangamano.
3. Uthibitishaji na Uumbizaji wa Papo Hapo
Sio tu kwamba inabadilisha data, lakini pia inapamba matokeo. Unapata OpenAPImpango safi, uliojikunja, na halali tayari kubandikwa kwenye components/schemassehemu yako.
Jinsi ya Kutumia Kibadilishaji
Bandika Msimbo wako: Nakili chanzo chako JSON Schemakwenye kihariri cha ingizo.
Chagua Toleo(Hiari): Chagua kama unataka matokeo yaboreshwe kwa ajili ya OpenAPI3.0 au kiwango kipya cha 3.1.
Bonyeza Geuza: Zana itachakata mantiki na kuonyesha matokeo yanayolingana na OpenAPI kwenye dirisha la matokeo.
Nakili na Utumie: Tumia kitufe cha "Nakili" ili kuchukua mpango wako mpya wa hati yako ya Swagger au Redocly.
Tofauti za Kiufundi za Kuzingatia
Kushughulikia Sifa "Isiyoweza Kufutwa"
Katika kiwango JSON Schema, sehemu inayoweza kubatilishwa mara nyingi hufafanuliwa kama type: ["string", "null"]. Katika OpenAPI3.0, hii lazima ibadilishwe kuwa type: stringna sifa tofauti nullable: true. Kibadilishaji chetu hushughulikia hii kiotomatiki.
Neno muhimu la "muundo"
OpenAPIHutumia formatneno muhimu zaidi kwa uthibitishaji(km, int32, int64, float, double). Zana yetu inahakikisha kwamba miundo hii inahifadhiwa na kupangwa kwa usahihi wakati wa mabadiliko.
Maswali Yanayoulizwa Mara kwa Mara(Maswali Yanayoulizwa Mara kwa Mara)
Je, kibadilishaji hiki kinaendana na Swagger 2.0?
Ingawa lengo ni OpenAPI3.x, michoro inayozalishwa inaendana kwa kiasi kikubwa na Swagger 2.0, ingawa marekebisho fulani ya definitionssehemu yanaweza kuhitajika.
Je, data yangu hutoka kwenye kivinjari changu?
Hapana. Mantiki yote ya ubadilishaji hutokea ndani ya kivinjari chako kwa kutumia JavaScript. Mifumo yako nyeti ya API haitumiwi kamwe kwenye seva zetu.
Je, ninaweza kubadilisha michoro mikubwa na tata?
Ndiyo. Zana yetu imeboreshwa ili kushughulikia michoro iliyojificha kwa undani na ufafanuzi wa vitu vikubwa bila kuchelewa kwa utendaji.