ஏபிஐ பிழை கையாளுதல்: HTTP நிலைக் குறியீடுகளுக்கான ஒரு விரிவான வழிகாட்டி

மென்பொருள் மேம்பாட்டு உலகில், ஏபிஐ-க்கள் (பயன்பாட்டு நிரலாக்க இடைமுகங்கள்) நவீன பயன்பாடுகளின் முதுகெலும்பாக மாறியுள்ளன, வெவ்வேறு அமைப்புகளுக்கு இடையே தடையற்ற தொடர்பு மற்றும் தரவுப் பரிமாற்றத்தை செயல்படுத்துகின்றன. ஏபிஐ-க்கள் உலகளவில் வணிக நடவடிக்கைகளுக்கு மிகவும் சிக்கலானதாகவும் ஒருங்கிணைந்ததாகவும் மாறுவதால், சரியான பிழை கையாளுதல் மிக முக்கியமானது. ஏபிஐ பிழை கையாளுதலின் மிக அடிப்படையான அம்சங்களில் ஒன்று HTTP நிலைக் குறியீடுகளின் பயன்பாடு ஆகும். இந்த வழிகாட்டி HTTP நிலைக் குறியீடுகளின் விரிவான கண்ணோட்டத்தையும், உலகெங்கிலும் உள்ள டெவலப்பர்களுக்குத் தெளிவான மற்றும் தகவலறிந்த பிழைச் செய்திகளை வழங்கும் வலுவான மற்றும் நம்பகமான ஏபிஐ-க்களை உருவாக்க அவற்றை எவ்வாறு திறம்படப் பயன்படுத்தலாம் என்பதையும் வழங்குகிறது.

HTTP நிலைக் குறியீடுகள் என்றால் என்ன?

HTTP நிலைக் குறியீடுகள் என்பது ஒரு கிளையன்ட்டின் கோரிக்கைக்குப் பதிலளிக்கும் வகையில் ஒரு சேவையகத்தால் வழங்கப்படும் மூன்று இலக்கக் குறியீடுகள் ஆகும். அவை கோரிக்கையின் விளைவைப் பற்றிய தகவல்களை வழங்குகின்றன, அது வெற்றிகரமாக இருந்ததா, பிழையை எதிர்கொண்டதா அல்லது மேலதிக நடவடிக்கை தேவையா என்பதைக் குறிப்பிடுகின்றன. இந்தக் குறியீடுகள் HTTP நெறிமுறையின் இன்றியமையாத பகுதியாகும் மற்றும் இணைய பொறியியல் பணிக்குழுவால் (IETF) RFC 7231 மற்றும் பிற தொடர்புடைய RFC-க்களில் தரப்படுத்தப்பட்டுள்ளன.

HTTP நிலைக் குறியீடுகள் ஐந்து வகுப்புகளாகப் பிரிக்கப்பட்டுள்ளன, ஒவ்வொன்றும் வெவ்வேறு வகை பதில்களைக் குறிக்கின்றன:

• 1xx (தகவல்): கோரிக்கை பெறப்பட்டு செயலாக்கப்படுகிறது. இந்தக் குறியீடுகள் ஏபிஐ பிழை கையாளுதலில் அரிதாகவே பயன்படுத்தப்படுகின்றன.
• 2xx (வெற்றி): கோரிக்கை வெற்றிகரமாகப் பெறப்பட்டு, புரிந்து கொள்ளப்பட்டு, ஏற்றுக்கொள்ளப்பட்டது.
• 3xx (வழிமாற்றுதல்): கோரிக்கையை முடிக்க கிளையன்ட் மேலும் நடவடிக்கை எடுக்க வேண்டும்.
• 4xx (கிளையன்ட் பிழை): கோரிக்கையில் தவறான தொடரியல் உள்ளது அல்லது அதை நிறைவேற்ற முடியாது. இது கிளையன்ட் பக்கத்தில் ஒரு பிழையைக் குறிக்கிறது.
• 5xx (சேவையக பிழை): சேவையகம் ஒரு சரியான கோரிக்கையை நிறைவேற்றத் தவறிவிட்டது. இது சேவையக பக்கத்தில் ஒரு பிழையைக் குறிக்கிறது.

ஏபிஐ பிழை கையாளுதலுக்கு HTTP நிலைக் குறியீடுகள் ஏன் முக்கியமானவை?

HTTP நிலைக் குறியீடுகள் பல காரணங்களுக்காக பயனுள்ள ஏபிஐ பிழை கையாளுதலுக்கு முக்கியமானவை:

• தரப்படுத்தப்பட்ட தொடர்பு: அவை சேவையகத்திற்கு ஒரு கோரிக்கையின் விளைவை கிளையன்ட்க்குத் தெரிவிப்பதற்கான ஒரு தரப்படுத்தப்பட்ட வழியை வழங்குகின்றன. இது டெவலப்பர்கள் தனிப்பயன் பிழைச் செய்திகளைப் புரிந்துகொள்ளத் தேவையில்லாமல் பிழைகளை எளிதில் புரிந்துகொண்டு கையாள அனுமதிக்கிறது.
• மேம்படுத்தப்பட்ட டெவலப்பர் அனுபவம்: தெளிவான மற்றும் தகவலறிந்த பிழைச் செய்திகள், பொருத்தமான HTTP நிலைக் குறியீடுகளுடன் சேர்ந்து, டெவலப்பர் அனுபவத்தை கணிசமாக மேம்படுத்துகின்றன. இது டெவலப்பர்கள் சிக்கல்களை விரைவாகக் கண்டறிந்து தீர்க்க அனுமதிக்கிறது, மேம்பாட்டு நேரத்தையும் விரக்தியையும் குறைக்கிறது.
• மேம்படுத்தப்பட்ட ஏபிஐ நம்பகத்தன்மை: விரிவான பிழைத் தகவல்களை வழங்குவதன் மூலம், HTTP நிலைக் குறியீடுகள் டெவலப்பர்கள் எதிர்பாராத சூழ்நிலைகளை நேர்த்தியாகக் கையாளக்கூடிய மேலும் வலுவான மற்றும் நம்பகமான பயன்பாடுகளை உருவாக்க உதவுகின்றன.
• எளிதாக்கப்பட்ட பிழைத்திருத்தம்: HTTP நிலைக் குறியீடுகள் பிழையின் மூலத்தை (கிளையன்ட் பக்கம் அல்லது சேவையகப் பக்கம்) தெளிவாகக் குறிப்பிடுவதன் மூலம் பிழைத்திருத்தத்தை எளிதாக்குகின்றன.
• உலகளாவிய நிலைத்தன்மை: உலகளாவிய பார்வையாளர்களுக்காக ஏபிஐ-க்களை உருவாக்கும்போது, வெவ்வேறு பிராந்தியங்கள் மற்றும் மொழிகளில் சீரான நடத்தையை உறுதிப்படுத்த தரப்படுத்தப்பட்ட பிழைக் குறியீடுகள் அவசியம். இது தெளிவின்மையைத் தவிர்த்து, உலகெங்கிலும் உள்ள டெவலப்பர்கள் சிக்கல்களை எளிதில் புரிந்துகொண்டு தீர்க்க அனுமதிக்கிறது.

பொதுவான HTTP நிலைக் குறியீடுகள் மற்றும் அவற்றின் அர்த்தங்கள்

ஏபிஐ பிழை கையாளுதலில் பயன்படுத்தப்படும் சில பொதுவான HTTP நிலைக் குறியீடுகளின் விவரம் இங்கே:

2xx வெற்றிக் குறியீடுகள்

• 200 OK: கோரிக்கை வெற்றிகரமாக இருந்தது. இது வெற்றிகரமான GET, PUT, PATCH, மற்றும் DELETE கோரிக்கைகளுக்கான நிலையான பதிலாகும்.
• 201 Created: கோரிக்கை வெற்றிகரமாக இருந்தது, மற்றும் ஒரு புதிய வளம் உருவாக்கப்பட்டது. இது பொதுவாக ஒரு வெற்றிகரமான POST கோரிக்கைக்குப் பிறகு பயன்படுத்தப்படுகிறது. எடுத்துக்காட்டாக, ஒரு புதிய பயனர் கணக்கை உருவாக்குதல்.
• 204 No Content: கோரிக்கை வெற்றிகரமாக இருந்தது, ஆனால் திருப்பி அனுப்ப உள்ளடக்கம் எதுவும் இல்லை. இது பெரும்பாலும் DELETE கோரிக்கைகளுக்குப் பயன்படுத்தப்படுகிறது, அங்கு எந்த மறுமொழி அமைப்பும் தேவையில்லை.

3xx வழிமாற்றுக் குறியீடுகள்

• 301 Moved Permanently: கோரப்பட்ட வளம் ஒரு புதிய URL-க்கு நிரந்தரமாக நகர்த்தப்பட்டுள்ளது. கிளையன்ட் அதன் இணைப்புகளைப் புதிய URL-க்குச் சுட்டிக்காட்டும்படி புதுப்பிக்க வேண்டும்.
• 302 Found: கோரப்பட்ட வளம் தற்காலிகமாக வேறு URL-இல் அமைந்துள்ளது. கிளையன்ட் எதிர்காலக் கோரிக்கைகளுக்கு அசல் URL-ஐத் தொடர்ந்து பயன்படுத்த வேண்டும். இது பெரும்பாலும் தற்காலிக வழிமாற்றுகளுக்குப் பயன்படுத்தப்படுகிறது.
• 304 Not Modified: கிளையன்டின் தற்காலிக சேமிப்பில் உள்ள வளத்தின் பதிப்பு இன்னும் செல்லுபடியாகும். சேவையகம் கிளையன்டிடம் தற்காலிக சேமிப்பில் உள்ள பதிப்பைப் பயன்படுத்தச் சொல்கிறது. இது அலைவரிசையைச் சேமித்து செயல்திறனை மேம்படுத்துகிறது.

4xx கிளையன்ட் பிழைக் குறியீடுகள்

இந்தக் குறியீடுகள் கிளையன்ட் கோரிக்கையில் பிழை செய்ததைக் குறிக்கின்றன. கிளையன்ட் என்ன தவறு செய்தது என்பதைத் தெரிவிப்பதற்கு இவை முக்கியமானவை, இதனால் அவர்கள் கோரிக்கையைச் சரிசெய்ய முடியும்.

• 400 Bad Request: தவறான தொடரியல் அல்லது செல்லாத அளவுருக்கள் காரணமாக சேவையகத்தால் கோரிக்கையைப் புரிந்து கொள்ள முடியவில்லை. எடுத்துக்காட்டாக, ஒரு தேவையான புலம் விடுபட்டிருந்தாலோ அல்லது தவறான தரவு வகையைக் கொண்டிருந்தாலோ.
• 401 Unauthorized: கோரிக்கைக்கு அங்கீகாரம் தேவை. கிளையன்ட் செல்லுபடியாகும் சான்றுகளை (எ.கா., ஏபிஐ விசை அல்லது JWT டோக்கன்) வழங்க வேண்டும். எடுத்துக்காட்டாக, உள்நுழையாமல் ஒரு பாதுகாக்கப்பட்ட வளத்தை அணுகுதல்.
• 403 Forbidden: கிளையன்ட் அங்கீகரிக்கப்பட்டுள்ளது ஆனால் கோரப்பட்ட வளத்தை அணுக அனுமதி இல்லை. எடுத்துக்காட்டாக, ஒரு பயனர் நிர்வாகிக்கு மட்டுமேயான ஒரு வளத்தை அணுக முயற்சிப்பது.
• 404 Not Found: கோரப்பட்ட வளத்தைச் சேவையகத்தில் கண்டுபிடிக்க முடியவில்லை. கிளையன்ட் இல்லாத ஒரு URL-ஐ அணுக முயற்சிக்கும்போது இது ஒரு பொதுவான பிழையாகும். எடுத்துக்காட்டாக, செல்லாத ID உடன் ஒரு பயனர் சுயவிவரத்தை அணுகுதல்.
• 405 Method Not Allowed: கோரிக்கையில் பயன்படுத்தப்பட்ட HTTP முறை கோரப்பட்ட வளத்திற்கு ஆதரிக்கப்படவில்லை. எடுத்துக்காட்டாக, படிக்க மட்டுமேயான ஒரு இறுதிப்புள்ளியில் ஒரு POST கோரிக்கையைப் பயன்படுத்த முயற்சிப்பது.
• 409 Conflict: வளத்தின் தற்போதைய நிலையுடன் ஒரு முரண்பாடு காரணமாக கோரிக்கையை முடிக்க முடியவில்லை. எடுத்துக்காட்டாக, ஏற்கனவே இருக்கும் ஒரு தனிப்பட்ட அடையாளங்காட்டியுடன் ஒரு வளத்தை உருவாக்க முயற்சிப்பது.
• 415 Unsupported Media Type: சேவையகம் கோரிக்கை அமைப்பின் மீடியா வகையை ஆதரிக்கவில்லை. எடுத்துக்காட்டாக, XML-ஐ மட்டும் ஏற்கும் ஒரு இறுதிப்புள்ளிக்கு JSON பேலோடை அனுப்புவது.
• 422 Unprocessable Entity: கோரிக்கை நன்கு வடிவமைக்கப்பட்டிருந்தது, ஆனால் சொற்பொருள் பிழைகள் காரணமாகச் செயலாக்க முடியவில்லை. இது பெரும்பாலும் சரிபார்ப்புப் பிழைகளுக்குப் பயன்படுத்தப்படுகிறது. எடுத்துக்காட்டாக, செல்லாத மின்னஞ்சல் வடிவம் அல்லது சிக்கலான தேவைகளைப் பூர்த்தி செய்யாத கடவுச்சொல்லுடன் ஒரு படிவத்தைச் சமர்ப்பிக்கும்போது.
• 429 Too Many Requests: கிளையன்ட் ஒரு குறிப்பிட்ட நேரத்தில் அதிகப்படியான கோரிக்கைகளை அனுப்பியுள்ளது. இது வீத வரம்புக்குப் பயன்படுத்தப்படுகிறது. எடுத்துக்காட்டாக, ஒரு பயனர் ஒரு மணி நேரத்திற்குச் செய்யக்கூடிய ஏபிஐ அழைப்புகளின் எண்ணிக்கையைக் கட்டுப்படுத்துதல்.

5xx சேவையகப் பிழைக் குறியீடுகள்

இந்தக் குறியீடுகள் சேவையகம் கோரிக்கையைச் செயலாக்கும்போது ஒரு பிழையை எதிர்கொண்டதைக் குறிக்கின்றன. அவை பொதுவாக சேவையகப் பக்கத்தில் ஒரு சிக்கலைக் குறிக்கின்றன மற்றும் விசாரணை தேவை.

• 500 Internal Server Error: சேவையகம் ஒரு எதிர்பாராத நிலையை எதிர்கொண்டதைக் குறிக்கும் ஒரு பொதுவான பிழைச் செய்தி. முடிந்தவரை மேலும் குறிப்பிட்ட பிழைச் செய்திகளை வழங்குவதன் மூலம் இது தவிர்க்கப்பட வேண்டும்.
• 502 Bad Gateway: சேவையகம், ஒரு நுழைவாயில் அல்லது ப்ராக்ஸியாகச் செயல்படும்போது, மற்றொரு சேவையகத்திலிருந்து ஒரு செல்லாத பதிலைப் பெற்றது. இது பெரும்பாலும் ஒரு அப்ஸ்ட்ரீம் சேவையகத்தில் ஒரு சிக்கலைக் குறிக்கிறது.
• 503 Service Unavailable: தற்காலிக அதிகச் சுமை அல்லது பராமரிப்பு காரணமாக சேவையகம் தற்போது கோரிக்கையைக் கையாள முடியவில்லை. எடுத்துக்காட்டாக, திட்டமிடப்பட்ட பராமரிப்பின்போது அல்லது திடீர் போக்குவரத்து அதிகரிப்பின்போது.
• 504 Gateway Timeout: சேவையகம், ஒரு நுழைவாயில் அல்லது ப்ராக்ஸியாகச் செயல்படும்போது, மற்றொரு சேவையகத்திலிருந்து சரியான நேரத்தில் ஒரு பதிலைப் பெறவில்லை. இது ஒரு அப்ஸ்ட்ரீம் சேவையகத்துடன் ஒரு காலக்கெடு சிக்கலைக் குறிக்கிறது.

ஏபிஐ-க்களில் HTTP நிலைக் குறியீடுகளைச் செயல்படுத்துவதற்கான சிறந்த நடைமுறைகள்

உங்கள் ஏபிஐ-க்களில் HTTP நிலைக் குறியீடுகளைத் திறம்படப் பயன்படுத்த, பின்வரும் சிறந்த நடைமுறைகளைக் கவனியுங்கள்:

• சரியான குறியீட்டைத் தேர்வு செய்யவும்: பிழையின் தன்மையைத் துல்லியமாகப் பிரதிபலிக்கும் மிகவும் பொருத்தமான HTTP நிலைக் குறியீட்டை கவனமாகத் தேர்ந்தெடுக்கவும். மேலும் குறிப்பிட்ட குறியீடு கிடைக்கும்போது 500 Internal Server Error போன்ற பொதுவான குறியீடுகளைப் பயன்படுத்துவதைத் தவிர்க்கவும்.
• தகவலறிந்த பிழைச் செய்திகளை வழங்கவும்: ஒவ்வொரு HTTP நிலைக் குறியீட்டுடனும் பிழையின் காரணத்தை விளக்கி, அதை எவ்வாறு தீர்ப்பது என்று பரிந்துரைக்கும் ஒரு தெளிவான மற்றும் சுருக்கமான பிழைச் செய்தியை இணைக்கவும். பிழைச் செய்தி மனிதர்களால் படிக்கக்கூடியதாகவும், பல்வேறு பின்னணியைச் சேர்ந்த டெவலப்பர்களால் எளிதில் புரிந்துகொள்ளக்கூடியதாகவும் இருக்க வேண்டும்.
• சீரான பிழை வடிவங்களைப் பயன்படுத்தவும்: HTTP நிலைக் குறியீடு, பிழைச் செய்தி, மற்றும் தொடர்புடைய எந்த பிழை விவரங்களையும் உள்ளடக்கிய பிழை பதில்களுக்கு ஒரு சீரான வடிவத்தை நிறுவவும். JSON என்பது ஏபிஐ பதில்களுக்கு மிகவும் பொதுவாகப் பயன்படுத்தப்படும் வடிவமாகும்.
• பிழைகளைப் பதிவு செய்யவும்: HTTP நிலைக் குறியீடு, பிழைச் செய்தி, கோரிக்கை விவரங்கள் மற்றும் தொடர்புடைய எந்த சூழல் தகவல்களையும் உள்ளடக்கிய அனைத்து ஏபிஐ பிழைகளையும் சேவையகப் பக்கத்தில் பதிவு செய்யவும். இது சிக்கல்களை விரைவாகக் கண்டறிந்து தீர்க்க உதவும்.
• விதிவிலக்குகளை நேர்த்தியாகக் கையாளவும்: எதிர்பாராத பிழைகள் உங்கள் பயன்பாட்டை முடக்குவதைத் தடுக்க உங்கள் குறியீட்டில் சரியான விதிவிலக்கு கையாளுதலைச் செயல்படுத்தவும். விதிவிலக்குகளைப் பிடித்து, பொருத்தமான HTTP நிலைக் குறியீடுகள் மற்றும் பிழைச் செய்திகளை கிளையன்ட்க்குத் திருப்பி அனுப்பவும்.
• உங்கள் ஏபிஐ-ஐ ஆவணப்படுத்தவும்: உங்கள் ஏபிஐ வழங்கக்கூடிய அனைத்து சாத்தியமான HTTP நிலைக் குறியீடுகளையும் பிழைச் செய்திகளையும் தெளிவாக ஆவணப்படுத்தவும். இது டெவலப்பர்கள் பிழைகளைக் கையாள்வது மற்றும் மேலும் வலுவான ஒருங்கிணைப்புகளை உருவாக்குவது எப்படி என்பதைப் புரிந்துகொள்ள உதவும். Swagger/OpenAPI போன்ற கருவிகள் தானாகவே ஏபிஐ ஆவணங்களை உருவாக்க முடியும்.
• வீத வரம்பைச் செயல்படுத்தவும்: வீத வரம்பைச் செயல்படுத்துவதன் மூலம் உங்கள் ஏபிஐ-ஐத் தவறாகப் பயன்படுத்துவதிலிருந்து பாதுகாக்கவும். ஒரு கிளையன்ட் வீத வரம்பை மீறும்போது 429 Too Many Requests பிழையைத் திருப்பி அனுப்பவும். இது உங்கள் ஏபிஐ அனைத்துப் பயனர்களுக்கும் கிடைப்பதை உறுதிசெய்ய உதவுகிறது.
• உங்கள் ஏபிஐ-ஐக் கண்காணிக்கவும்: பிழைகள் மற்றும் செயல்திறன் சிக்கல்களுக்கு உங்கள் ஏபிஐ-ஐக் கண்காணிக்கவும். பிழைகள் ஏற்படும்போது உங்களுக்குத் தெரிவிக்க விழிப்பூட்டல்களை அமைக்கவும், இதனால் நீங்கள் விரைவாக விசாரித்து அவற்றைத் தீர்க்க முடியும். Datadog, New Relic, மற்றும் Prometheus போன்ற கருவிகளை ஏபிஐ கண்காணிப்புக்குப் பயன்படுத்தலாம்.
• உள்ளூர்மயமாக்கலைக் (சர்வதேசமயமாக்கல்) கருத்தில் கொள்ளவும்: உலகளாவிய பார்வையாளர்களுக்குச் சேவை செய்யும் ஏபிஐ-க்களுக்கு, பிழைச் செய்திகளை வெவ்வேறு மொழிகளில் உள்ளூர்மயமாக்குவதைக் கருத்தில் கொள்ளவும். இது ஆங்கிலம் பேசாத டெவலப்பர்களுக்கான டெவலப்பர் அனுபவத்தை கணிசமாக மேம்படுத்துகிறது. மொழிபெயர்ப்புகளை நிர்வகிக்க நீங்கள் ஒரு மொழிபெயர்ப்புச் சேவை அல்லது வளத் தொகுப்புகளைப் பயன்படுத்தலாம்.

செயல்பாட்டில் HTTP நிலைக் குறியீடுகளின் எடுத்துக்காட்டுகள்

பல்வேறு ஏபிஐ சூழ்நிலைகளில் HTTP நிலைக் குறியீடுகளை எவ்வாறு பயன்படுத்தலாம் என்பதற்கான சில நடைமுறை எடுத்துக்காட்டுகள் இங்கே:

எடுத்துக்காட்டு 1: பயனர் அங்கீகாரம்

ஒரு கிளையன்ட் தவறான சான்றுகளைப் பயன்படுத்தி ஒரு ஏபிஐ உடன் அங்கீகரிக்க முயற்சிக்கிறது.

கோரிக்கை:

POST /auth/login
Content-Type: application/json

{
  "username": "invalid_user",
  "password": "wrong_password"
}

பதில்:

HTTP/1.1 401 Unauthorized
Content-Type: application/json

{
  "error": {
    "code": "invalid_credentials",
    "message": "Invalid username or password"
  }
}

இந்த எடுத்துக்காட்டில், சேவையகம் ஒரு 401 Unauthorized நிலைக் குறியீட்டைத் திருப்பி அனுப்புகிறது, இது கிளையன்ட் அங்கீகரிக்கத் தவறிவிட்டது என்பதைக் குறிக்கிறது. பதில் அமைப்பில் பிழையின் காரணத்தை விளக்கும் ஒரு பிழைக் குறியீடு மற்றும் செய்தியுடன் ஒரு JSON பொருள் உள்ளது.

எடுத்துக்காட்டு 2: வளம் காணப்படவில்லை

ஒரு கிளையன்ட் இல்லாத ஒரு வளத்தை மீட்டெடுக்க முயற்சிக்கிறது.

கோரிக்கை:

GET /users/12345

பதில்:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "error": {
    "code": "resource_not_found",
    "message": "User with ID 12345 not found"
  }
}

இந்த எடுத்துக்காட்டில், சேவையகம் ஒரு 404 Not Found நிலைக் குறியீட்டைத் திருப்பி அனுப்புகிறது, இது கோரப்பட்ட வளம் இல்லை என்பதைக் குறிக்கிறது. பதில் அமைப்பில் குறிப்பிட்ட ID கொண்ட பயனர் காணப்படவில்லை என்பதை விளக்கும் ஒரு பிழைக் குறியீடு மற்றும் செய்தியுடன் ஒரு JSON பொருள் உள்ளது.

எடுத்துக்காட்டு 3: சரிபார்ப்புப் பிழை

ஒரு கிளையன்ட் செல்லாத தரவுகளுடன் ஒரு புதிய வளத்தை உருவாக்க முயற்சிக்கிறது.

கோரிக்கை:

POST /users
Content-Type: application/json

{
  "name": "",
  "email": "invalid_email"
}

பதில்:

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
  "errors": [
    {
      "field": "name",
      "code": "required",
      "message": "Name is required"
    },
    {
      "field": "email",
      "code": "invalid_format",
      "message": "Email is not a valid email address"
    }
  ]
}

இந்த எடுத்துக்காட்டில், சேவையகம் ஒரு 422 Unprocessable Entity நிலைக் குறியீட்டைத் திருப்பி அனுப்புகிறது, இது கோரிக்கை நன்கு வடிவமைக்கப்பட்டிருந்தாலும் சரிபார்ப்புப் பிழைகள் காரணமாகச் செயலாக்க முடியவில்லை என்பதைக் குறிக்கிறது. பதில் அமைப்பில் பிழைகளின் பட்டியலுடன் ஒரு JSON பொருள் உள்ளது, ஒவ்வொன்றும் பிழையை ஏற்படுத்திய புலம், ஒரு பிழைக் குறியீடு மற்றும் பிழையை விளக்கும் ஒரு செய்தியைக் கொண்டுள்ளது.

HTTP நிலைக் குறியீடுகள் மற்றும் ஏபிஐ பாதுகாப்பு

HTTP நிலைக் குறியீடுகளின் சரியான பயன்பாடு ஏபிஐ பாதுகாப்பிற்கும் பங்களிக்க முடியும். எடுத்துக்காட்டாக, அதிகப்படியான வார்த்தைகள் கொண்ட பிழைச் செய்திகளைத் தவிர்ப்பது தாக்குபவர்கள் உங்கள் அமைப்பைப் பற்றிய முக்கியமான தகவல்களைப் பெறுவதைத் தடுக்கலாம். அங்கீகாரம் மற்றும் அங்கீகாரப் பிழைகளைக் கையாளும்போது, கணக்கு கணக்கீடு அல்லது பிற தாக்குதல்களைத் தடுக்க சீரான மற்றும் வெளிப்படுத்தாத பிழைச் செய்திகளைத் திருப்பி அனுப்புவது முக்கியம்.

தரமான HTTP நிலைக் குறியீடுகளுக்கு அப்பால்: தனிப்பயன் பிழைக் குறியீடுகள்

தரமான HTTP நிலைக் குறியீடுகள் பரந்த அளவிலான சூழ்நிலைகளை உள்ளடக்கியிருந்தாலும், ஒரு பிழையைப் பற்றிய மேலும் குறிப்பிட்ட தகவல்களை வழங்க நீங்கள் தனிப்பயன் பிழைக் குறியீடுகளை வரையறுக்க வேண்டிய சந்தர்ப்பங்கள் இருக்கலாம். தனிப்பயன் பிழைக் குறியீடுகளைப் பயன்படுத்தும்போது, அவற்றை தரமான HTTP நிலைக் குறியீட்டுடன் பதில் அமைப்பில் சேர்ப்பது பரிந்துரைக்கப்படுகிறது. இது கிளையன்ட்கள் பிழையின் வகையை எளிதில் கண்டறிந்து பொருத்தமான நடவடிக்கை எடுக்க அனுமதிக்கிறது.

ஏபிஐ பிழை கையாளுதலைச் சோதிப்பதற்கான கருவிகள்

பல கருவிகள் உங்கள் ஏபிஐ பிழை கையாளுதலைச் சோதிக்கவும் சரிபார்க்கவும் உதவும்:

• Postman: உங்கள் ஏபிஐ-க்கு கோரிக்கைகளை அனுப்பவும், HTTP நிலைக் குறியீடுகள் மற்றும் பிழைச் செய்திகள் உட்பட பதில்களை ஆய்வு செய்யவும் உங்களை அனுமதிக்கும் ஒரு பிரபலமான ஏபிஐ கிளையன்ட்.
• Swagger Inspector: உங்கள் OpenAPI வரையறைக்கு எதிராக உங்கள் ஏபிஐ-ஐச் சோதிக்கவும், பிழை கையாளுதலில் ஏதேனும் முரண்பாடுகளைக் கண்டறியவும் உங்களை அனுமதிக்கும் ஒரு கருவி.
• தானியங்கு சோதனை கட்டமைப்புகள்: உங்கள் ஏபிஐ பிழை கையாளுதலின் சரியான தன்மையைச் சரிபார்க்கும் சோதனைகளை எழுத Jest, Mocha, அல்லது Pytest போன்ற தானியங்கு சோதனை கட்டமைப்புகளைப் பயன்படுத்தவும்.

முடிவுரை

HTTP நிலைக் குறியீடுகள் ஏபிஐ பிழை கையாளுதலின் ஒரு அடிப்படை அம்சமாகும், மேலும் அவை உலகளாவிய பார்வையாளர்களுக்காக வலுவான, நம்பகமான மற்றும் பயனர் நட்பு ஏபிஐ-க்களை உருவாக்குவதற்கு அவசியம். வெவ்வேறு HTTP நிலைக் குறியீடுகளைப் புரிந்துகொண்டு, அவற்றைச் செயல்படுத்துவதற்கான சிறந்த நடைமுறைகளைப் பின்பற்றுவதன் மூலம், நீங்கள் டெவலப்பர் அனுபவத்தை கணிசமாக மேம்படுத்தலாம், பிழைத்திருத்தத்தை எளிதாக்கலாம் மற்றும் உங்கள் ஏபிஐ-க்களின் ஒட்டுமொத்த தரத்தை மேம்படுத்தலாம். சரியான குறியீட்டைத் தேர்வுசெய்யவும், தகவலறிந்த பிழைச் செய்திகளை வழங்கவும், சீரான பிழை வடிவங்களைப் பயன்படுத்தவும், உங்கள் ஏபிஐ-ஐ முழுமையாக ஆவணப்படுத்தவும் நினைவில் கொள்ளுங்கள். அவ்வாறு செய்வதன் மூலம், நீங்கள் பயன்படுத்த எளிதான, மேலும் நம்பகமான மற்றும் தொடர்ந்து மாறிவரும் டிஜிட்டல் நிலப்பரப்பின் சவால்களைச் சமாளிக்க நன்கு பொருத்தப்பட்ட ஏபிஐ-க்களை உருவாக்குவீர்கள்.