API பணிப்பாய்வு வழிகாட்டி

நீங்கள் எதை உருவாக்க விரும்புகிறீர்கள்?

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

ஐந்து நடைமுறைப் பாதைகள்

எண்ட்பாயிண்ட் பட்டியலுடன் அல்ல, முடிவோடு தொடங்குங்கள்.

Selected: Harden a client

பாதை 1 மேக்ரோ தரவை மீட்டெடுக்கவும் ஒரு சுத்தமான கால வரிசையை மீட்டெடுத்து, அதன் மூல மற்றும் தரக் மெட்டாடேட்டாவை அதன் அருகிலேயே வைத்திருங்கள். பாதை 2 வெளியீட்டு வேலைகளைத் திட்டமிடவும் தெரிந்த வெளியீட்டு நேரங்களில் இலக்கு பணிகளை இயக்க வெளியீட்டு காலெண்டரைப் பயன்படுத்தவும். பாதை 3 ஆச்சரியங்களை அளவிடவும் லுக்அஹெட் பயாஸை (lookahead bias) அறிமுகப்படுத்தாமல், வெளியிடப்பட்ட மதிப்புடன் வெளியீட்டுக்கு முந்தைய கணிப்புகளை இணைக்கவும். பாதை 4 லைவ் அப்டேட்களைப் பெறுங்கள் SSE ஐ ஒரு செல்லாத சமிக்ஞையாகப் பயன்படுத்தவும், பின்னர் REST இலிருந்து முழுமையான பதிவைப் பெறவும். பாதை 5 ஒரு மேக்ரோ மாடலை உருவாக்குங்கள் தொடர்புடைய குறிகாட்டிகளின் ஒரு சிறிய குழுவை மூல-லேபிளிடப்பட்ட கரன்சி ஸ்கோர் கார்டாக மாற்றவும்.

உங்கள் 14-நாள் API சோதனை

முதல் கோரிக்கையிலிருந்து தக்கவைக்கத்தக்க ஒரு வேலைக்கு முன்னேறுங்கள்.

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

API முன்னேற்றத்தைச் சரிபார்க்கவும்

நாள் 0

அணுகலை நிரூபிக்கவும்

திறவுகோலை உருவாக்கவும், அங்கீகரிக்கப்பட்ட ஒரு கோரிக்கையை பூர்த்தி செய்யவும் மற்றும் அதன் மெட்டாடேட்டையுடன் முதல் பதிலைச் சேமிக்கவும்.

படிநிலையைத் திறக்கவும் →

நாட்கள் 1-2

கோரிக்கையை நம்பகமானதாக மாற்றவும்

அங்கீகார அல்லது வடிகட்டி சிக்கல்களைத் தீர்த்து, முதல் ஸ்கிரிப்டை ஒரு பெயரிடப்பட்ட மீண்டும் செய்யக்கூடிய வேலையாக மாற்றவும்.

படிநிலையைத் திறக்கவும் →

நாட்கள் 3-4

வெளியீட்டு நேரத்தைச் சேர்க்கவும்

காலண்டரை இரண்டாவது எண்ட்பாயிண்ட் குடும்பமாகப் பயன்படுத்தி அடுத்த பயனுள்ள API இயக்கத்தைத் திட்டமிடுங்கள்.

படிநிலையைத் திறக்கவும் →

நாட்கள் 5-7

ஆராய்ச்சி வெளியீட்டை உருவாக்குங்கள்

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

படிநிலையைத் திறக்கவும் →

நாட்கள் 8-10

புதுப்பிப்புகளைத் தானியக்கமாக்கவும்

திட்டமிடப்பட்ட REST, SSE, அல்லது வெபஹூக்குகளைத் தேர்ந்தெடுத்து, வேறு நாளில் மற்றொரு வெற்றிகரமான API இயக்கத்தை முடிக்கவும்.

படிநிலையைத் திறக்கவும் →

நாட்கள் 11-13

கிளையண்ட்டை வலுப்படுத்துங்கள்

டைம்-அவுட்கள், வரையறுக்கப்பட்ட மறுமுயற்சிகள், பதில் சரிபார்ப்பு, அங்கீகார-பாதுகாப்பான லாகிங் மற்றும் காலாவதியான தரவு கண்காணிப்பைச் சேர்க்கவும்.

படிநிலையைத் திறக்கவும் →

நாள் 14

ஆதாரங்களை மதிப்பாய்வு செய்யவும்

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

படிநிலையைத் திறக்கவும் →

Production readiness

ஒரு API கிளையண்ட்டை தயாரிப்புக்குத் தயார் செய்யவும்

Production reliability comes from treating status codes differently, keeping retries bounded, reusing ETags, and choosing scheduled REST, SSE, or webhooks for the job.

25 minutes Production pattern அறிவிப்புகள்changesstreamwebhooks

செயல்படும் உதாரணம்

உங்கள் கீயை இதில் வைத்திருங்கள் FXMD_API_KEY; அதை ஒருபோதும் மூலக் கட்டுப்பாட்டில் (source control) ஒட்ட வேண்டாம்.

import os
import requests
from urllib3.util.retry import Retry

session = requests.Session()
retry = Retry(total=3, backoff_factor=0.5, status_forcelist=(429, 502, 503, 504))
session.mount("https://", requests.adapters.HTTPAdapter(max_retries=retry))

response = session.get(
    "https://api.fxmacrodata.com/v1/announcements/eur/inflation",
    params={"api_key": os.environ["FXMD_API_KEY"], "limit": 5},
    headers={"Accept-Encoding": "gzip"},
    timeout=(3.05, 20),
)
response.raise_for_status()

எதிர்பார்க்கப்படும் முடிவு: A bounded client that handles transient failures without retry storms and is ready to add ETag-based conditional refreshes.

முதல் ஸ்கிரிப்ட் ஒரு உண்மையான அமைப்பாக மாறும் போது

பிரச்சனை தீர்த்தல் மற்றும் production வழிகாட்டுதல்

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

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