Conas a dhearann tú freagraí earráide comhsheasmhacha agus a thuairiscíonn tú earráidí validation?

Question

IT Interview Practice · Accepted Answer

Déanann dea-fhreagra earráide dhá rud: úsáideann sé an **HTTP status code ceart** (an comhartha inléite ag meaisín), agus filleann sé **body comhsheasmhach struchtúrtha** ar féidir le forbróir gníomhú air. Tá cruthanna earráide neamhréireacha ar cheann de na foinsí is mó de phian ar thaobh an chliaint.

## Úsáid formáid earráide caighdeánach: RFC 7807 (problem+json)

Sainmhíníonn RFC 7807 body caighdeánach "problem details" le media type tiomnaithe, ionas go mbreathnaíonn gach earráid ar fud do API mar an gcéanna:

```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 a aithníonn catagóir na hearráide (in-díthagartha chuig docs).
- `title` — achoimre ghairid, inléite ag duine (cobhsaí in aghaidh gach `type`).
- `status` — an HTTP status, scáthánaithe ar mhaithe le caoithiúlacht.
- `detail` — míniú sonrach don *tarlú seo*.
- `instance` — cén t-iarratas/acmhainn ar tharla sé air.

## Earráidí validation: tuairiscigh iad go léir ag an am céanna

Le haghaidh validation form/field, fill `422` (nó `400`) agus **eagar earráidí réimse** ionas gur féidir leis an gcliant gach droch-réimse a aibhsiú in aon phas amháin — ní earráid amháin ag an am:

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

## Prionsabail

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

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

Is é dearadh earráide an áit a n-éiríonn nó a dteipeann le APIanna go ciúin sa saol fíor: tá an happy path éasca, ach caitheann tomhaltóirí an chuid is mó dá n-am dífhabhtaithe sa chonair earráide, agus fágann conradh earráide neamhréireach nó doiléir go bhfuil comhtháthú ainnis. Úsáideann agallóirí é seo chun dhá rud a sheiceáil. Ar dtús, **status code móide body struchtúrtha ag obair le chéile** — is é an status an comhartha garbh do tooling agus atrialacha, iompraíonn an body an mionsonra ingníomhaithe — seachas frithphatrún `200 OK` le hearráid istigh. Ar an dara dul síos, **cód earráide cobhsaí inléite ag meaisín** (trí `type` RFC 7807 nó réimse `code`) ionas gur féidir le cliaint craobhú ar `"insufficient_funds"` seachas teaghrán-mheaitseáil teachtaireacht Bhéarla a d'fhéadfaí a athfhoclú nó a logánú. Slánaíonn gach earráid validation a fhilleadh ag an am céanna, agus gan mionsonraí inmheánacha ar nós stack traces a sceitheadh riamh, freagra a léiríonn gur thóg tú APIanna a chaith foirne eile a ídiú i ndáiríre.

Úsáid formáid earráide caighdeánach: RFC 7807 (problem+json)

Earráidí validation: tuairiscigh iad go léir ag an am céanna

Prionsabail

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

Ceisteanna gaolmhara