Ar Líne JSON Schemago OpenAPITiontaire
Is féidir gur tasc láimhe leadránach é do mhúnlaí sonraí a aistriú idir caighdeáin éagsúla. Uathoibríonn ár n -Uathoibriú JSON Schemato OpenAPIConverterJSON Schema an próiseas seo, rud a ligeann duit sainmhínithe caighdeánacha a thiontú láithreach go formáidí atá comhoiriúnach OpenAPIle Sonraíocht(OAS). Cibé an bhfuil tú ag tógáil doiciméadacht Swagger nó ag sainmhíniú comhlachtaí iarratais/freagartha, cinntíonn an uirlis seo cruinneas agus comhlíonadh.
Cén fáth Tiontaigh JSON Schemago OpenAPI?
Cé go OpenAPIn-úsáideann(Swagger roimhe seo) fo-thacar de JSON Schema, tá difríochtaí criticiúla ann maidir le conas a láimhseáiltear eochairfhocail áirithe cosúil le type, nullable, agus idir leaganacha éagsúla(Dréacht 4, 7, nó 2019-09) agus na sonraíochtaí 3.0/3.1.formatOpenAPI
Ag Dul i nGleic leis an mBearna Chomhoiriúnachta
OpenAPITá srianta sonracha ag 3.0 atá difriúil ón gcaighdeán JSON Schema. Déileálann ár dtiontaire leis na castachtaí seo, amhail tiontú dependenciesgo loighic chomhoiriúnach nó typeeagair a choigeartú chun freastal ar OpenAPIriachtanais dhiana, rud a chinntíonn go bhfanann do dhoiciméadú API bailí.
Sruthlíniú a dhéanamh ar Fhorbairt API
In ionad do mhúnlaí bunachar sonraí nó scéimeanna bailíochtaithe a athscríobh do do dhoiciméid API, is féidir leat do chuid atá ann cheana a ghreamú go simplí JSON Schema. Laghdaíonn sé seo earráid dhaonna agus coinníonn sé do loighic agus do dhoiciméadacht chúltaca sioncrónaithe go foirfe.
Príomhghnéithe ár dTiontaire
Tá ár n-uirlis deartha do fhorbróirí a bhfuil cruinneas agus luas ag teastáil uathu agus sonraíochtaí API á mbainistiú acu.
1. Tacaíocht do JSON SchemaDhréachtaí Ilghnéitheacha
Cibé acu atá do scéim foinse bunaithe ar Dhréacht 4, 7, nó 2020-12, aithníonn ár n-inneall an struchtúr agus mapálann sé é chuig an OpenAPIgcoibhéis is gaire.
2. OpenAPIRéidh le haghaidh 3.0 & 3.1
OpenAPITá 3.1 comhoiriúnach go hiomlán anois le JSON Schema2019-09. Mar sin féin, má tá 3.0 á úsáid agat fós OpenAPI, déanfaidh ár n-uirlis réimsí sonracha a "íosghrádú" go huathoibríoch(mar shampla nullable: truein ionad type: ["string", "null"]) chun comhoiriúnacht a choinneáil.
3. Bailíochtú & Formáidiú Meandarach
Ní hamháin go ndéanann sé na sonraí a thiontú, ach déanann sé an t-aschur a mhaisiú freisin. Gheobhaidh tú OpenAPIscéim ghlan, iontráilte, agus bhailí atá réidh le greamú isteach i do components/schemaschuid.
Conas an Tiontaire a Úsáid
Greamaigh do Chód: Cóipeáil do fhoinse JSON Schemaisteach san eagarthóir ionchuir.
Roghnaigh Leagan(Roghnach): Roghnaigh an bhfuil tú ag iarraidh an t-aschur a bharrfheabhsú do OpenAPI3.0 nó don chaighdeán 3.1 níos nuaí.
Cliceáil Tiontaigh: Próiseálfaidh an uirlis an loighic agus taispeánfaidh sí an toradh atá comhoiriúnach le OpenAPI sa fhuinneog aschuir.
Cóipeáil & Úsáid: Úsáid an cnaipe "Cóipeáil" chun do scéim nua a fháil do do dhoiciméadú Swagger nó Redocly.
Difríochtaí Teicniúla le Faire Amach Dóibh
Láimhseáil an Airí "Nullable"
I gcaighdeán JSON Schema, is minic a shainmhínítear réimse neamhní mar type: ["string", "null"]. I OpenAPI3.0, ní mór é seo a thiontú go type: stringle maoin ar leith nullable: true. Láimhseálann ár dtiontaire é seo go huathoibríoch.
An eochairfhocal "formáid"
OpenAPIúsáideann an formateochairfhocal níos forleithne le haghaidh bailíochtaithe(m.sh., int32, int64, float, double). Cinntíonn ár n-uirlis go gcoimeádtar na formáidí seo agus go mapáiltear iad i gceart le linn an chlaochlaithe.
Ceisteanna Coitianta(CC)
An bhfuil an tiontaire seo comhoiriúnach le Swagger 2.0?
Cé go bhfuil an fócas ar OpenAPI3.x, tá na scéimeanna ginte comhoiriúnach den chuid is mó le Swagger 2.0, cé go mb’fhéidir go mbeadh gá le roinnt coigeartuithe don definitionschuid.
An bhfágann mo chuid sonraí mo bhrabhsálaí?
Ní hea. Tarlaíonn an loighic chomhshó go léir go háitiúil i do bhrabhsálaí ag baint úsáide as JavaScript. Ní sheoltar do scéimeanna API íogaire chuig ár bhfreastalaithe choíche.
An féidir liom scéimeanna móra, casta a thiontú?
Sea. Tá ár n-uirlis optamaithe chun scéimeanna neadaithe go domhain agus sainmhínithe réad móra a láimhseáil gan mhoill ar fheidhmíocht.