---
title: "Cobhsaíocht API"
version: 6.1
locale: ga
source: https://docs.djangoproject.com/ga/6.1/misc/api-stability/
canonical: https://djangodocs.dev/ga/6.1/misc/api-stability/
---
# Cobhsaíocht API

Tá Django tiomanta do chobhsaíocht API agus do chomhoiriúnacht chun cinn. Go hachomair, ciallaíonn sé seo go leanfaidh cód a fhorbraíonn tú i gcoinne leagan de Django ag obair le heisiúintí amach anseo. Seans go mbeidh ort mionathruithe a dhéanamh agus an leagan de Django a úsáideann do thionscadal á uasghrádú agat: féach an rannán "Athruithe Neamh-chomhoiriúnacha Siar" den nóta scaoileadh 1 don leagan nó do na leaganacha a bhfuil tú ag uasghrádú orthu.

Ag an am céanna le cobhsaíocht API a dhéanamh mar thosaíocht an-ard, tá Django tiomanta freisin d'fheabhsú leanúnach, chomh maith le bheith dírithe ar "bealach amháin chun é a dhéanamh" (faoi dheireadh) sna APIanna a chuirimid ar fáil. Ciallaíonn sé seo nuair a aimsímid go soiléir bealaí níos fearr chun rudaí a dhéanamh, go ndéanfaimid neamhaird de na seanbhealaí agus ar deireadh thiar thall. Tá sé mar aidhm againn creat gréasáin iontaofa, nua-aimseartha den chaighdeán is airde a sholáthar a spreagann dea-chleachtais i ngach tionscadal a úsáideann é. Trí leas a bhaint as feabhsuithe incriminteacha, déanaimid iarracht marbhántacht agus uasghrádú mór briseadh a sheachaint.

## Cad a chiallaíonn "cobhsaí".

Sa chomhthéacs seo, ciallaíonn cobhsaí:

- Ní bhogfar nó ní athainmneofar gach API poiblí (gach rud sa doiciméadú seo) gan ailiasanna atá comhoiriúnach ar gcúl a sholáthar.
- Má chuirtear gnéithe nua leis na APIanna seo -- rud is féidir go leor -- ní bhrisfidh siad ná ní athróidh siad brí na modhanna atá ann cheana féin. I bhfocail eile, ní chiallaíonn "cobhsaí" (go riachtanas) "iomlán."
- Más rud é, ar chúis éigin, go gcaithfear API dearbhaithe cobhsaí a bhaint nó a athsholáthar, dearbhófar go bhfuil sé dímheasta ach fanfaidh sé san API ar feadh dhá eisiúint gné ar a laghad. Eiseofar rabhaidh nuair a ghlaofar an modh dímheasta.

  Féach : ref: oifigiúil-eisiúintí le haghaidh tuilleadh sonraí ar conas a oibríonn scéim uimhrithe leaganacha Django, agus conas a dhéanfar gnéithe a dhímheas.
- Ní bhrisfimid ar gcúl comhoiriúnacht na APInna seo gan próiseas dímheasa ach amháin má fhágann fabht nó poll slándála é go hiomlán dosheachanta.

## APIs Cobhsaí

Go ginearálta, meastar go bhfuil gach rud atá clúdaithe sa doiciméadú -- cé is moite d'aon rud sa [limistéar inmheánach](/ga/6.1/internals/) cobhsaí.

## Eisceachtaí

Tá roinnt eisceachtaí ann maidir leis an gealltanas cobhsaíochta agus cúl-chomhoiriúnachta seo.

### Ceartúcháin slándála

Má thugaimid faoi deara fadhb slándála -- tá súil againn go ndéanfaidh duine éigin ár  -- déanfaimid gach rud is gá chun í a réiteach. D’fhéadfadh go gciallódh sé seo comhoiriúnacht a bhriseadh ar gcúl; slándáil trumps an ráthaíocht comhoiriúnachta.

### APIs marcáilte mar inmheánach

Tá APIanna áirithe marcáilte go sainráite mar “inmheánach” ar chúpla bealach:

- Tagraíonn roinnt doiciméadú do inmheánaigh agus luaitear iad mar sin. Má deir an doiciméadú go bhfuil rud éigin inmheánach, coimeádaimid an ceart chun é a athrú.
- Feidhmeanna, modhanna, agus oibiachtaí eile arna réamhshocrú le príomhscór (`_`). Is é seo an bealach Python caighdeánach a chur in iúl go bhfuil rud éigin príobháideach; má thosaíonn modh ar bith le `_` amháin, is API inmheánach é.