இந்தப் பட்டியல் பற்றி
பெரும்பாலான API ஆவணங்கள் எங்கு தவறுகின்றன
ஏராளமான வழிகாட்டிகள் இறுதிப்புள்ளிகளைப் (endpoints) பட்டியலிட்டாலும், குழப்பத்தை ஏற்படுத்தும் உண்மையான விவரங்களை விடுத்துவிடுகின்றன: அங்கீகாரம் நடைமுறையில் எவ்வாறு செயல்படுகிறது, துல்லியமான கோரிக்கை மற்றும் பதில் உதாரணங்கள், மற்றும் குறிப்பிட்ட பிழைகளின் அர்த்தம் என்ன, அவற்றை எவ்வாறு சரிசெய்வது போன்றவை. இது நிகழும்போது, டெவலப்பர்கள் உதவி கோரிக்கைகளை (support tickets) சமர்ப்பிக்க முற்படுகிறார்கள், இது ஆவணங்கள் இருப்பதன் நோக்கத்தையே பாழாக்கிவிடுகிறது.
எங்களின் அணுகுமுறை
நாங்கள் அனுமானங்களைச் சார்ந்திருக்காமல், நேரடியாக உங்கள் மூலக் குறியீட்டிலிருந்தே ஆவணங்களை உருவாக்குகிறோம். நேரடிச் சான்றுகளைப் பயன்படுத்தி நாங்களே API-ஐச் சோதிப்பதற்கு முன், உங்கள் வழிகள் (routes), சரிபார்ப்பு தர்க்கம் (validation logic) மற்றும் பிழை கையாளுதல் ஆகியவற்றை ஆய்வு செய்கிறோம். இறுதி ஆவணத்தில் உள்ள ஒவ்வொரு உதாரணமும் நாங்கள் அனுப்பிய உண்மையான கோரிக்கையையும், நாங்கள் பெற்ற பதிலையும் குறிக்கிறது; இதன் மூலம் புனையப்பட்ட விவரங்களோ அல்லது சாத்தியமற்ற நிலை குறியீடுகளோ (status codes) இல்லை என்பது உறுதி செய்யப்படுகிறது.
நீங்கள் பெறுபவை
- அங்கீகார வழிகாட்டுதல்: டோக்கன் வழங்குதல், புதுப்பித்தல் மற்றும் அமர்வின் நடுவில் அதன் காலாவதியானால் என்ன நடக்கும் என்பது.
- அளவுருக்கள், செயல்படும் உதாரணக் கோரிக்கை மற்றும் உண்மையான பதில் அமைப்பு உட்பட ஒவ்வொரு இறுதிப்புள்ளியின் முழுமையான விவரங்கள்.
- வெறும் பிழைச் செய்தியை மட்டும் மீண்டும் கூறாமல், ஒவ்வொரு குறியீட்டையும் அதன் காரணத்துடனும் சரிசெய்யும் முறையுடனும் இணைக்கும் பிழைக் குறிப்பு.
- ஒரு புதிய டெவலப்பரை தொடக்க நிலையிலிருந்து வெற்றிகரமான அழைப்பு வரை கொண்டு செல்ல வடிவமைக்கப்பட்ட விரைவுத் தொடக்கப் பாதை.
- விகித வரம்புகள் (rate limits), பக்கமாக்கம் (pagination), வெப்ஹூக்குகள் (webhooks) மற்றும் ஐடெம்போடன்சி (idempotency) ஆகியவை தொடர்பான பொருத்தமான குறிப்புகள்.
வழங்கும் வடிவம்
உங்கள் களஞ்சியத்திற்கு (repository) ஏற்ற வகையில், OpenAPI அல்லது ஆவண வலைத்தளத்திற்குப் பொருந்தும் விதமாக கட்டமைக்கப்பட்ட Markdown-ஐ நாங்கள் வழங்குகிறோம்; உங்கள் குழு எதைப் புதுப்பித்து பராமரிக்குமோ அதற்கேற்ப இது அமையும். உங்கள் பயனர்கள் நம்பியிருக்கும் மொழிகளில் குறியீட்டு மாதிரிகள் வழங்கப்பட்டு, அவற்றை இயக்கிப் பார்த்து சோதிக்கப்படுகின்றன. நீங்கள் கோரினால் Postman-பாணி தொகுப்பும் சேர்க்கப்படலாம்.
உங்களிடமிருந்து எங்களுக்குத் தேவைப்படுபவை
உங்கள் களஞ்சியம் அல்லது OpenAPI கோப்பிற்கான அணுகல், சோதனை சூழலுக்கான செயல்படும் சான்றுகள், மற்றும் உங்கள் ஆதரவுக் குழு அடிக்கடி பதிலளிக்கும் கேள்விகள் - இவை வழிகாட்டியின் கட்டமைப்பை வடிவமைக்க உதவுகின்றன.
இதில் எவை சேர்க்கப்படவில்லை
இந்தச் சேவையானது மென்பொருள் எவ்வாறு செயல்படுகிறது என்பதற்கான துல்லியமான தொழில்நுட்ப ஆவணங்களை மட்டுமே உள்ளடக்கியது; விளம்பர அல்லது சந்தைப்படுத்தல் உள்ளடக்கம் என்பது தனிப் பணியாகும்.
செயல்முறை மற்றும் காலக்கெடு
நீங்கள் ஒரு முழுமையான முதல் வரைவைப் பெறுவீர்கள், உங்கள் ஆதரவுக் குழு கையாளும் தொடர்ச்சியான கேள்விகளுடன் அதை நீங்கள் ஒப்பிட்டுப் பார்க்கலாம். பிழையான ஒன்றை மெருகூட்டி வழங்குவதை விட, ஒரு பொறியாளர் விளிம்பு நிலை நிகழ்வுகளை (edge cases) முன்கூட்டியே சுட்டிக்காட்டுவதையே நாங்கள் விரும்புகிறோம். ஒவ்வொரு உதாரணமும் உங்கள் நேரடி API-இல் இயக்கப்பட்டு சோதிக்கப்பட்டதால், இறுதி ஆவணத்தில் உள்ள எதுவும் கற்பனையானது அல்ல.
இந்தத் தொகுப்பு ஒரு நிலையான விலையிலான API ஆவணப் பணியை உள்ளடக்கியது; இது ஒரு முறை திருத்தத்துடன் (revision), ஒரே முறையில் வழங்கப்படுகிறது, இதன் விலை 500.99 USD மற்றும் முடிக்கும் காலம் 10 நாட்கள் ஆகும். இந்த ஆர்டர் தொடர்புடைய டொமைனையும் உங்கள் தேவைக் குறிப்பையும் நீங்கள் வழங்க வேண்டும்.