Hitilafu na majaribio ya kurudia
API za Alkax hutumia misimbo ya hali ya HTTP kwa matokeo ya msingi na miili ya majibu yenye muundo kwa maelezo yanayosomeka na mashine na watu.
Misimbo ya kawaida ya hali
| Hali | Maana | Hatua ya mteja |
|---|---|---|
400 | Ombi batili au kushindwa kwa uhakiki | Sahihisha ombi kabla ya kulituma tena |
401 | Kitambulisho kinakosekana, hakijaundwa vizuri, ni batili, kimeisha muda au kimebatilishwa | Badilisha kitambulisho |
402 | Usajili wa kulipia unahitajika | Washa au fanya upya usajili wa mwenye mradi |
403 | Utambulisho umethibitishwa lakini hakuna ruhusa | Kagua ruhusa, ufikiaji na umiliki wa tenant |
404 | Rasilimali haipatikani au haionekani kwa tenant huyu | Hakiki kitambulisho thabiti; usichunguze kwa kurudia |
409 | Mgongano wa mzunguko wa maisha, nakala rudufu au idempotency | Soma rasilimali ya sasa na upatanishe |
429 | Kikomo cha kasi au mgao wa mpango wa mwezi umefikiwa | Heshimu Retry-After, punguza matumizi au boresha mpango |
5xx | Kushindwa kwa muda kwa seva | Jaribu tena mara chache zilizowekewa kikomo, ukiongeza muda wa kusubiri kwa hatua za kizidishi |
Njia salama ya kujaribu tena
- Weka muda wa mwisho wa kusubiri ombi.
- Jaribu tena tu kwa kushindwa kwa mtandao,
429na matokeo ya muda ya5xxyaliyoandikwa. - Tumia tena ufunguo uleule wa idempotency unapojaribu tena ombi lilelile la kuunda.
- Ongeza muda wa kusubiri kwa hatua za kizidishi pamoja na utofauti wa nasibu.
- Acha baada ya idadi maalumu ya majaribio na uoneshe tatizo ili likaguliwe.
Usirudie kamwe jibu la 400 bila kubadilisha ombi. Epuka kuunda ufunguo mpya wa idempotency kwa sababu tu jibu la kwanza lilipotea; hilo linaweza kugeuza kitendo kimoja kilichokusudiwa kuwa viwili.
Ujumbe wa lugha za eneo
Baadhi ya API hutafsiri ujumbe unaosomeka na watu kulingana na Accept-Language. Usifanye mantiki ya programu itegemee maandishi yaliyotafsiriwa. Badala yake hifadhi hali, kitambulisho thabiti cha rasilimali na msimbo wa hitilafu unaosomeka na mashine.