JSON API-யா XML API-யா?

JSON-ஐயா XML-ஐயா என்று தேர்ந்தெடுப்பது கிளையன்ட்டுக்கும் API-க்கும் இடையிலான ஒப்பந்தத்துக்குள் அடங்கும் விஷயம். வெற்றி, சரிபார்ப்புப் பிழைகள் (validation errors), அங்கீகாரத் தோல்விகள், rate limit-கள், தற்காலிக சர்வர் பிழைகள் ஆகியவற்றைக் கிளையன்ட் தனித்தனியாக அடையாளம் காண வேண்டும். JSON-ஆ XML-ஆ என்பது HTTP-யின் பொருளை (semantics) மாற்றாது; IPv4/IPv6 மதிப்புகளை IPv4 நீளத்தை அனுமானிக்காமல் முழுமையாகப் பாதுகாக்க வேண்டும்.

பதிலை எப்படிக் கையாள்வது

Content-Type, நிலைக் குறியீடு, ஆவணப்படுத்தப்பட்ட புலங்கள், ஒதுக்கீடு (quota) ஆகியவற்றைச் சரிபாருங்கள். HTTP 429-ஐத் தனியாகக் கையாளுங்கள்; Retry-After அனுப்பப்பட்டால் அதைப் பின்பற்றுங்கள்; ஜிட்டர் சேர்த்த, வரம்புக்குட்பட்ட exponential backoff-ஐப் பயன்படுத்துங்கள். மீண்டும் முயல்வதற்கு முன் idempotency-ஐக் கருத்தில் கொள்ளுங்கள். கோரிக்கை அடையாளங்காட்டிகள், நிலை, தாமதம் ஆகியவற்றைப் பதிவு செய்யுங்கள்; ஆனால் API ரகசியங்களை ஒருபோதும் பதிவு செய்யாதீர்கள்.

கவனிக்க வேண்டிய முக்கிய விவரம்

JSON பொதுவான object/array தரவு மாதிரிகளுடன் இயல்பாகப் பொருந்துகிறது, பொதுவாகச் சுருக்கமாகவும் இருக்கும்; XML attributes, namespaces, முதிர்ந்த schema கருவிகள் ஆகியவற்றை ஆதரிக்கிறது. ஒரு வடிவம்தான் எல்லா இடங்களிலும் வேகமானது அல்லது சரியானது என்று அனுமானிக்காமல், API ஒப்பந்தத்தையும் அதைச் சுற்றியுள்ள சூழலையும் (ecosystem) வைத்துத் தேர்ந்தெடுங்கள். உண்மையான கோரிக்கைக்கும் தற்போதைய API ஒப்பந்தத்துக்கும் 2IP API பக்கத்தைப் பாருங்கள்.