Akan layi JSON Schemazuwa OpenAPIMai Canzawa
Canja wurin samfuran bayananka tsakanin ma'auni daban-daban na iya zama aiki mai wahala da hannu. Mu JSON Schemazuwa OpenAPIConverter yana sarrafa wannan tsari ta atomatik, yana ba ku damar canza JSON Schemama'anoni na yau da kullun zuwa OpenAPItsarin da ya dace da ƙayyadaddun bayanai(OAS) nan take. Ko kuna gina takaddun Swagger ko kuma kuna bayyana ƙungiyoyin buƙata/amsawa, wannan kayan aikin yana tabbatar da daidaito da bin ƙa'idodi.
Me yasa ake canza JSON Schemazuwa OpenAPI?
Duk da cewa OpenAPI(a da Swagger) yana amfani da wani ɓangare na JSON Schema, akwai manyan bambance-bambance a yadda wasu kalmomi kamar type, nullable, da kuma formatyadda ake sarrafa su tsakanin nau'ikan daban-daban(Draft 4, 7, ko 2019-09) da OpenAPIƙayyadaddun 3.0/3.1.
Cika Gibin Dacewa
OpenAPI3.0 yana da takamaiman ƙuntatawa waɗanda suka bambanta da na yau da kullun JSON Schema. Mai canza mu yana kula da waɗannan bambance-bambancen, kamar canzawa dependencieszuwa dabaru masu dacewa ko daidaita typejeri don biyan OpenAPIbuƙatunmu masu tsauri, yana tabbatar da cewa takaddun API ɗinku suna da inganci.
Sauƙaƙa Ci gaban API
Maimakon sake rubuta samfuran bayananka ko tsarin tabbatarwa don takardun API ɗinka, kawai zaka iya liƙa fayil ɗin da kake da shi JSON Schema. Wannan yana rage kuskuren ɗan adam kuma yana sa dabarun bayan ƙarshenka da takardunka su kasance daidai.
Muhimman Siffofin Mai Canza Mu
An tsara kayan aikinmu don masu haɓakawa waɗanda ke buƙatar daidaito da sauri yayin sarrafa ƙayyadaddun API.
1. Tallafi ga Zane-zane da JSON SchemaYawa
Ko tsarin tushen ku ya dogara ne akan Daftari na 4, 7, ko 2020-12, injin mu yana gano tsarin kuma yana taswirar shi zuwa mafi kusa OpenAPI.
2. OpenAPI3.0 & 3.1 A shirye
OpenAPI3.1 yanzu ya dace sosai da JSON Schema2019-09. Duk da haka, idan har yanzu kuna amfani da OpenAPI3.0, kayan aikinmu zai "rage darajar" takamaiman filayen(kamar nullable: truemaimakon type: ["string", "null"]) ta atomatik don kiyaye jituwa.
3. Tabbatarwa & Tsarin Nan Take
Ba wai kawai yana canza bayanai ba, har ma yana ƙawata fitarwa. Za ku sami OpenAPItsari mai tsabta, mai lanƙwasa, kuma mai inganci wanda aka shirya don liƙa a cikin components/schemassashin ku.
Yadda Ake Amfani da Mai Canzawa
Manna Lambarka: Kwafi tushenka JSON Schemazuwa cikin editan shigarwa.
Zaɓi Sigar(Zaɓi): Zaɓi ko kuna son a inganta fitowar don OpenAPI3.0 ko sabuwar ma'aunin 3.1.
Danna Convert: Kayan aikin zai sarrafa dabaru kuma ya nuna sakamakon da ya dace da OpenAPI a cikin taga fitarwa.
Kwafi & Amfani: Yi amfani da maɓallin "Kwafi" don ɗaukar sabon tsarin ku na takardun Swagger ko Redoly.
Bambancin Fasaha da Ya Kamata a Kula
Gudanar da Kadarar "Nullable"
A cikin daidaitaccen tsari JSON Schema, sau da yawa ana bayyana filin da ba za a iya nullawa ba kamar haka type: ["string", "null"]. A cikin OpenAPI3.0, dole ne a canza wannan zuwa type: stringwani nullable: trueabu daban. Mai canza mu yana sarrafa wannan ta atomatik.
Kalmar "tsarin"
OpenAPIyana amfani da formatkalmar sirri sosai don tabbatarwa(misali, int32, int64, float) double. Kayan aikinmu yana tabbatar da cewa an adana waɗannan tsare-tsaren kuma an tsara su daidai yayin canjin.
Tambayoyin da Ake Yawan Yi(FAQ)
Shin wannan na'urar canzawa ta dace da Swagger 2.0?
Duk da cewa an mayar da hankali kan OpenAPI3.x, tsarin da aka samar ya dace da Swagger 2.0, kodayake definitionsana iya buƙatar wasu gyare-gyare don ɓangaren.
Shin bayanai na suna barin mai bincike na?
A'a. Duk wata dabara ta juyawa tana faruwa ne a cikin burauzarka ta amfani da JavaScript. Ba a taɓa aika tsarin API ɗinku masu mahimmanci zuwa sabar mu ba.
Zan iya canza manyan tsare-tsare masu rikitarwa?
Eh. An inganta kayan aikinmu don sarrafa tsare-tsare masu zurfi da manyan ma'anoni ba tare da jinkirin aiki ba.