Yaya kake ƙira error responses masu daidaito da bayar da rahoton kuskuren validation?

Question

IT Interview Practice · Accepted Answer

Kyakkyawan error response yana yin abubuwa biyu: yana amfani da **madaidaicin HTTP status code** (siginar da inji ke karantawa), kuma yana mayar da **body mai daidaito, mai tsari** da mai haɓaka zai iya aiki a kansa. Siffofin kuskure marasa daidaito na ɗaya daga cikin manyan tushen zafi a gefen client.

## Yi amfani da tsarin kuskure na ma'auni: RFC 7807 (problem+json)

RFC 7807 yana ayyana body na "problem details" na ma'auni tare da media type na musamman, don haka kowane kuskure a cikin API ɗinka yana kama iri ɗaya:

```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 da ke gane rukunin kuskure (ana iya dereference zuwa docs).
- `title` — takaitaccen bayani da mutum ke iya karantawa (mai ƙarko ga kowane `type`).
- `status` — HTTP status, an maimaita don sauƙi.
- `detail` — bayani na musamman ga *wannan* faruwa.
- `instance` — a wane request/resource ya faru.

## Kuskuren validation: bayar da rahotonsu duka lokaci guda

Ga validation na form/field, mayar da `422` (ko `400`) da **array na field errors** don client ya iya haskaka kowane field mara kyau a wucewa ɗaya — ba kuskure ɗaya a lokaci ba:

```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" }
  ]
}
```

## Ƙa'idoji

```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
```

## Me ya sa yake da muhimmanci

Ƙira na kuskure shi ne inda APIs ke yin nasara ko gazawa a shiru a duniyar gaske: happy path yana da sauƙi, amma masu amfani suna kashe yawancin lokacin debug ɗinsu a hanyar kuskure, kuma yarjejeniyar kuskure mara daidaito ko marar tabbas tana sa integration ta zama mai wahala. Masu hira suna amfani da wannan don duba abubuwa biyu. Na farko, **status code tare da structured body suna aiki tare** — status shi ne siginar da'ira ga tooling da retries, body yana ɗauke da cikakken bayani mai aiki — maimakon anti-pattern na `200 OK` da kuskure a ciki. Na biyu, **error code mai ƙarko da inji ke karantawa** (ta `type` na RFC 7807 ko field na `code`) don clients su iya reshe kan `"insufficient_funds"` maimakon daidaita string na saƙon Ingilishi da za a iya sake fasalta ko yin localize. Mayar da dukkan kuskuren validation lokaci guda, da rashin taɓa fitar da cikakkun bayanai na cikin gida kamar stack traces, yana kammala amsa da ke nuna ka gina APIs da wasu ƙungiyoyi suka yi amfani da su da gaske.

Yi amfani da tsarin kuskure na ma'auni: RFC 7807 (problem+json)

Kuskuren validation: bayar da rahotonsu duka lokaci guda

Ƙa'idoji

Me ya sa yake da muhimmanci

Tambayoyi masu alaƙa