Cad iad na príomhstraitéisí versioning API, agus conas a dhíomhaoiníonn tú (deprecate) leagan?

Question

IT Interview Practice · Accepted Answer

Ligeann versioning duit API a fhorbairt le **breaking changes** gan cliaint atá ann cheana a bhriseadh. Tá trí phríomhstraitéis ann, chomh maith le próiseas deprecation.

## Na trí straitéis

**1. URI versioning** — tá an leagan sa path.
```http
GET /v1/users/42 HTTP/1.1
GET /v2/users/42 HTTP/1.1
```
Is é an ceann is simplí agus is infheicthe; éasca le route, cache, agus test i mbrabhsálaí. Míbhuntáiste: sáraíonn sé go teicniúil "aithníonn an URI acmhainn" (tá dhá URL ag an user céanna anois). Is é seo an rogha is coitianta go mór (GitHub, Stripe go stairiúil).

**2. Custom header versioning** — taistealaíonn an leagan i header.
```http
GET /users/42 HTTP/1.1
X-API-Version: 2
```
Coinníonn sé URLanna glan ach tá sé dofheicthe i mbrabhsálaí agus níos deacra le cache.

**3. Media-type (content negotiation) versioning** — leagan in `Accept`.
```http
GET /users/42 HTTP/1.1
Accept: application/vnd.example.v2+json
```
An ceann is "RESTful" (tá URL na hacmhainne cobhsaí; ní dhéantar ach a representation a leaganú), ach an ceann is lú insroichte do thomhaltóirí.

## Cad a áirítear mar breaking

```text
BREAKING      → bain/athainmnigh field, athraigh cineál, athraigh auth, teann validation
NON-BREAKING  → cuir field optional nua leis, cuir endpoint nua leis, cuir luach enum leis*
```
Ní theastaíonn ach ó breaking changes leagan nua; cuir non-breaking changes leis an gceann reatha.

## Próiseas deprecation

1. **Fógair** le dátaí sna docs agus sa changelog.
2. **Comhartha ag runtime** le headers ionas go dtabharfaidh cliaint faoi deara go cláraitheach:
```http
HTTP/1.1 200 OK
Deprecation: true
Sunset: Sat, 31 Jan 2026 23:59:59 GMT
Link: <https://api.example.com/v2/users/42>; rel="successor-version"
```
3. **Déan monatóireacht** ar úsáid an tseanleagain agus déan teagmháil leis na glaoiteoirí atá fágtha.
4. **Sunset** ach amháin tar éis d'úsáid titim gar do náid.

## Cén fáth a bhfuil sé tábhachtach

Fiafraíonn agallóirí é seo chun a fheiceáil an féidir leat API a fhás i dtáirgeadh gan na cliaint a bhraitheann air a bhriseadh — fíorimní oibríochtúil, ní ceann teoiriciúil. Déanann na freagraí is láidre dhá idirdhealú: ar dtús, go bhfuil **an chuid is mó de na hathruithe non-breaking** agus nár chóir dóibh version bump a spreagadh ar chor ar bith (téann athruithe breisitheacha isteach sa leagan reatha), ag cur versioning i leataobh d'athruithe atá breaking i ndáiríre; agus ar an dara dul síos, go bhfuil an *straitéis* níos lú tábhachtach ná an *próiseas* — is é amlíne deprecation soiléir le headers `Deprecation`/`Sunset` agus monatóireacht úsáide a chosnaíonn tomhaltóirí i ndáiríre. Buann URI versioning i gcleachtas mar gheall ar a infheictheacht agus a thacaíocht tooling, ach léiríonn eolas ar na comhbhabhtálacha (coinníonn header agus media-type URLanna cobhsaí agus tá siad níos RESTful, ar chostas inléiteachta) go dtuigeann tú spás an deartha seachas gan ach `/v1/` a chóipeáil go caoch.

Na trí straitéis

Cad a áirítear mar breaking

Próiseas deprecation

Cén fáth a bhfuil sé tábhachtach

Ceisteanna gaolmhara