ஆன்லைனில் JSON Schemaஇருந்து OpenAPIமாற்றி
உங்கள் தரவு மாதிரிகளை வெவ்வேறு தரநிலைகளுக்கு இடையில் நகர்த்துவது ஒரு கடினமான கையேடு பணியாக இருக்கலாம். எங்கள் JSON Schemato OpenAPIConverterJSON Schema இந்த செயல்முறையை தானியங்குபடுத்துகிறது, இது நிலையான வரையறைகளை உடனடியாக OpenAPIவிவரக்குறிப்பு(OAS) இணக்கமான வடிவங்களாக மாற்ற உங்களை அனுமதிக்கிறது. நீங்கள் Swagger ஆவணங்களை உருவாக்கினாலும் அல்லது கோரிக்கை/பதில் அமைப்புகளை வரையறுத்தாலும், இந்த கருவி துல்லியம் மற்றும் இணக்கத்தை உறுதி செய்கிறது.
ஏன் மாற்ற JSON Schemaவேண்டும் OpenAPI?
OpenAPI(முன்னர் ஸ்வாகர்) இன் துணைக்குழுவைப் பயன்படுத்தினாலும், போன்ற சில முக்கிய வார்த்தைகள் வெவ்வேறு பதிப்புகள்(வரைவு 4, 7, அல்லது 2019-09) மற்றும் 3.0/3.1 விவரக்குறிப்புகளுக்கு இடையில் எவ்வாறு கையாளப்படுகின்றன JSON Schemaஎன்பதில் முக்கியமான வேறுபாடுகள் உள்ளன .typenullableformatOpenAPI
பொருந்தக்கூடிய இடைவெளியைக் குறைத்தல்
OpenAPI3.0 தரநிலையிலிருந்து வேறுபடும் குறிப்பிட்ட கட்டுப்பாடுகளைக் கொண்டுள்ளது. இணக்கமான தர்க்கத்திற்கு மாற்றுவது அல்லது உங்கள் API ஆவணங்கள் செல்லுபடியாகும் என்பதை உறுதிசெய்ய, கடுமையான தேவைகளைப் பூர்த்தி செய்ய வரிசைகளை சரிசெய்வது JSON Schemaபோன்ற நுணுக்கங்களை எங்கள் மாற்றி கையாளுகிறது .dependenciestypeOpenAPI
ஸ்ட்ரீம்லைன் API மேம்பாடு
உங்கள் API ஆவணங்களுக்கான தரவுத்தள மாதிரிகள் அல்லது சரிபார்ப்புத் திட்டங்களை மீண்டும் எழுதுவதற்குப் பதிலாக, நீங்கள் ஏற்கனவே உள்ளதை ஒட்டலாம் JSON Schema. இது மனிதப் பிழையைக் குறைத்து, உங்கள் பின்தள தர்க்கம் மற்றும் ஆவணங்களை முழுமையாக ஒத்திசைவில் வைத்திருக்கும்.
எங்கள் மாற்றியின் முக்கிய அம்சங்கள்
API விவரக்குறிப்புகளை நிர்வகிக்கும்போது துல்லியம் மற்றும் வேகம் தேவைப்படும் டெவலப்பர்களுக்காக எங்கள் கருவி வடிவமைக்கப்பட்டுள்ளது.
JSON Schema1. பல வரைவுகளுக்கான ஆதரவு
உங்கள் மூலத் திட்டம் வரைவு 4, 7 அல்லது 2020-12 ஐ அடிப்படையாகக் கொண்டதாக இருந்தாலும், எங்கள் இயந்திரம் கட்டமைப்பைக் கண்டறிந்து அதை மிக நெருக்கமான OpenAPIசமமானதாக வரைபடமாக்குகிறது.
2. OpenAPI3.0 & 3.1 தயார்
OpenAPI3.1 இப்போது 2019-09 உடன் முழுமையாக இணக்கமாக உள்ளது JSON Schema. இருப்பினும், நீங்கள் இன்னும் 3.0 ஐப் பயன்படுத்துகிறீர்கள் என்றால், எங்கள் கருவி இணக்கத்தன்மையைப் பராமரிக்க குறிப்பிட்ட புலங்களை(என்பதற்குப் பதிலாக) OpenAPIதானாகவே "தரமிறக்கும்" .nullable: truetype: ["string", "null"]
3. உடனடி சரிபார்ப்பு & வடிவமைத்தல்
இது தரவை மாற்றுவது மட்டுமல்லாமல், வெளியீட்டை அழகுபடுத்துகிறது. OpenAPIஉங்கள் பிரிவில் ஒட்டுவதற்குத் தயாராக இருக்கும் ஒரு சுத்தமான, உள்தள்ளப்பட்ட மற்றும் செல்லுபடியாகும் திட்டத்தைப் பெறுவீர்கள் components/schemas.
மாற்றியை எவ்வாறு பயன்படுத்துவது
உங்கள் குறியீட்டை ஒட்டவும்:JSON Schema உங்கள் மூலத்தை உள்ளீட்டு எடிட்டரில் நகலெடுக்கவும் .
பதிப்பைத் தேர்ந்தெடுக்கவும்(விரும்பினால்):OpenAPI வெளியீடு 3.0 அல்லது புதிய 3.1 தரநிலைக்கு உகந்ததாக்கப்பட வேண்டுமா என்பதைத் தேர்வுசெய்யவும் .
மாற்று என்பதைக் கிளிக் செய்யவும்: கருவி தர்க்கத்தை செயலாக்கி, வெளியீட்டு சாளரத்தில் OpenAPI- இணக்கமான முடிவைக் காண்பிக்கும்.
நகலெடுத்துப் பயன்படுத்து: உங்கள் Swagger அல்லது Redocly ஆவணங்களுக்கான புதிய திட்டத்தைப் பெற "நகலெடு" பொத்தானைப் பயன்படுத்தவும்.
கவனிக்க வேண்டிய தொழில்நுட்ப வேறுபாடுகள்
"தவறான" சொத்தை கையாளுதல்
தரநிலையில் JSON Schema, ஒரு nullable புலம் பெரும்பாலும் என வரையறுக்கப்படுகிறது. 3.0type: ["string", "null"] இல், இது ஒரு தனி பண்புடன் மாற்றப்பட வேண்டும். எங்கள் மாற்றி இதை தானாகவே கையாளுகிறது.OpenAPItype: stringnullable: true
"வடிவமைப்பு" முக்கிய சொல்
OpenAPIformatசரிபார்ப்புக்காக முக்கிய சொல்லை அதிகமாகப் பயன்படுத்துகிறது(எ.கா., int32, int64, float, double). மாற்றத்தின் போது இந்த வடிவங்கள் பாதுகாக்கப்பட்டு சரியாக வரைபடமாக்கப்படுவதை எங்கள் கருவி உறுதி செய்கிறது.
அடிக்கடி கேட்கப்படும் கேள்விகள்(FAQ)
இந்த மாற்றி ஸ்வாகர் 2.0 உடன் இணக்கமாக உள்ளதா?
3.x இல் கவனம் செலுத்தப்பட்டாலும் OpenAPI, உருவாக்கப்பட்ட திட்டங்கள் பெரும்பாலும் ஸ்வாகர் 2.0 உடன் இணக்கமாக உள்ளன, இருப்பினும் பிரிவுக்கு சில மாற்றங்கள் definitionsதேவைப்படலாம்.
எனது தரவு எனது உலாவியிலிருந்து வெளியேறுகிறதா?
இல்லை. அனைத்து மாற்று தர்க்கங்களும் உங்கள் உலாவியில் JavaScript ஐப் பயன்படுத்தி உள்ளூரில் நடக்கும். உங்கள் முக்கியமான API திட்டங்கள் எங்கள் சேவையகங்களுக்கு ஒருபோதும் அனுப்பப்படாது.
பெரிய, சிக்கலான திட்டங்களை நான் மாற்ற முடியுமா?
ஆம். எங்கள் கருவி செயல்திறன் பின்னடைவு இல்லாமல் ஆழமாக உள்ளமைக்கப்பட்ட திட்டங்கள் மற்றும் பெரிய பொருள் வரையறைகளைக் கையாள உகந்ததாக உள்ளது.