Kif tiddisinja error responses konsistenti u tirrapporta l-iżbalji tal-validazzjoni?

Question

IT Interview Practice · Accepted Answer

Error response tajba tagħmel żewġ affarijiet: tuża l-**HTTP status code t-tajjeb** (is-sinjal li tinqara mill-magna), u tirritorna **body strutturat u konsistenti** li żviluppatur jista' jaġixxi fuqu. Forom ta' żball inkonsistenti huma waħda mill-akbar sorsi ta' uġigħ fuq in-naħa tal-client.

## Uża format ta' żball standard: RFC 7807 (problem+json)

RFC 7807 jiddefinixxi body "problem details" standard b'media type dedikat, biex kull żball fl-API tiegħek jidher l-istess:

```http
HTTP/1.1 404 Not Found
Content-Type: application/problem+json

{
  "type": "https://api.example.com/errors/not-found",
  "title": "Resource not found",
  "status": 404,
  "detail": "No user exists with id 999",
  "instance": "/users/999"
}
```

- `type` — URI li jidentifika l-kategorija tal-iżball (dereferenceable għad-docs).
- `title` — sommarju qasir li jinqara mill-bniedem (stabbli għal kull `type`).
- `status` — l-HTTP status, riflettut għall-konvenjenza.
- `detail` — spjegazzjoni speċifika għal *din* l-okkorrenza.
- `instance` — fuq liema request/resource ġara.

## Iżbalji tal-validazzjoni: irrapportahom kollha f'daqqa

Għall-validazzjoni tal-form/field, irritorna `422` (jew `400`) u **array ta' żbalji tal-field** biex il-client ikun jista' jenfasizza kull field ħażin f'darba waħda — mhux żball wieħed kull darba:

```http
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/problem+json

{
  "type": "https://api.example.com/errors/validation",
  "title": "Validation failed",
  "status": 422,
  "errors": [
    { "field": "email", "code": "invalid_format", "message": "must be a valid email" },
    { "field": "age",   "code": "out_of_range",   "message": "must be >= 18" }
  ]
}
```

## Prinċipji

```text
✓ Same body shape for every error (one code path on the client)
✓ A stable machine-readable code (type/code) — clients branch on this, not on prose
✓ Human-readable message for developers/logs
✗ Never leak stack traces, SQL, or internal paths to clients
```

## Għaliex huwa importanti

Id-disinn tal-iżball huwa fejn l-APIs bil-kwiet jirnexxu jew ifallu fid-dinja reali: il-happy path huwa faċli, imma l-konsumaturi jqattgħu l-biċċa l-kbira tal-ħin tad-debugging fil-mogħdija tal-iżball, u kuntratt ta' żball inkonsistenti jew vag jagħmel l-integrazzjoni miżerabbli. L-intervistaturi jużaw dan biex jiċċekkjaw żewġ affarijiet. L-ewwel, **status code flimkien ma' body strutturat li jaħdmu flimkien** — l-istatus huwa s-sinjal ħoxxa għat-tooling u r-retries, il-body iġorr id-dettall li fuqu tista' taġixxi — aktar milli l-anti-pattern ta' `200 OK` b'żball ġewwa. It-tieni, **kodiċi ta' żball stabbli u li jinqara mill-magna** (permezz tat-`type` ta' RFC 7807 jew field `code`) biex il-clients jistgħu jaqsmu fuq `"insufficient_funds"` aktar milli jqabblu string ta' messaġġ bl-Ingliż li jista' jinbidel jew jiġi lokalizzat. Li tirritorna l-iżbalji kollha tal-validazzjoni f'daqqa, u qatt ma tikxef dettalji interni bħal stack traces, itemm tweġiba li turi li bnejt APIs li timijiet oħra kellhom tabilħaqq jikkonsmaw.

Uża format ta' żball standard: RFC 7807 (problem+json)

Iżbalji tal-validazzjoni: irrapportahom kollha f'daqqa

Prinċipji

Għaliex huwa importanti

Mistoqsijiet relatati