API లను ఎలా సంస్కరణ చేస్తారు మరియు సేవలలో వెనుకకు సంబంధితత్వాన్ని ఎలా నిర్వహిస్తారు?

Question

Accepted Answer

సేవలు స్వతంత్రంగా స్థాపించబడినందున, కాలర్లు ఒకేసారి అપ్‌గ్రేడ్ చేస్తారని మీరు ఎప్పుడూ అనుకోలేరు. **API సంస్కరణ** మరియు **వెనుకకు సంబంధితత్వం** ఉత్పత్తిదారులను ఇప్పటికే ఉన్న వినియోగదారులను విచ్ఛిన్నం చేయకుండా అభివృద్ధి చేయడానికి అనుమతిస్తుంది.

## సంస్కరణ వ్యూహాలు

| వ్యూహం | ఉదాహరణ |
|---|---|
| URI మార్గం | `GET /v2/orders/42` |
| శీర్షిక | `Accept: application/vnd.api.v2+json` |
| స్కీమా పరిణామం | ఫీల్డ్‌లను జోడించండి, ఎప్పుడూ తీసివేయవద్దు/పేరు మార్చవద్దు |

## సంకలితమైన (విచ్ఛిన్నం చేయని) మార్పులను ఇష్టపడండి

```text
NON-BREAKING (safe):
  ✓ add a new optional field
  ✓ add a new endpoint
  ✓ add a new enum value (if clients tolerate unknowns)

BREAKING (needs a new version):
  ✗ remove or rename a field
  ✗ change a type or make a field required
  ✗ change semantics of an existing field
```

## Protobuf దీనికి స్నేహపూర్వకమైనది

```proto
message Order {
  string id = 1;
  double total = 2;
  string currency = 3;  // NEW field 3 — old clients ignore it safely
}
```

ఫీల్డ్ సంఖ్యలు, నామస్థానాలు కాదు, వైర్ ఫార్మాట్‌ను నిర్ణయిస్తాయి, కాబట్టి ఫీల్డ్‌లను జోడించడం వెనుకకు సంబంధితమైనది.

## జీవిత చక్రం

```text
Release v2 ─▶ run v1 + v2 together ─▶ migrate consumers ─▶ deprecate v1 ─▶ remove v1
```

## విషయం

వాస్తవ ట్రాఫిక్ ఇప్పటికీ దానిని ఉపయోగిస్తున్నప్పుడు ఎప్పుడూ సంస్కరణను తీసివేయవద్దు. నిష్క్రియం చేయడానికి ముందు వినియోగాన్ని ట్రాక్ చేయండి.

## ఇది ఎందుకు ముఖ్యమైనది

స్వతంత్ర నిస్సరణ పనిచేస్తుంది, ఎందుకంటే ఉత్పత్తిదారుడు ప్రతి వినియోగదారు విడుదల సమన్వయం లేకుండా మార్పును పంపగలరు.

సంకలితం మార్పు మరియు సస్థానం సమయంలో పాత సంస్కరణలకు సమర్థన కోసం డిజైన్ చేయడం అనేది ఆ స్వతంత్రతను సంరక్షించేది, నిర్భందపరమైన బిగ్-బ్యాంగ్ అప్‌గ్రేడ్‌లను బలవంతం చేయుటకు బదులుగా.

URI మార్గం	`GET /v2/orders/42`
శీర్షిక	`Accept: application/vnd.api.v2+json`
స్కీమా పరిణామం	ఫీల్డ్‌లను జోడించండి, ఎప్పుడూ తీసివేయవద్దు/పేరు మార్చవద్దు