API response contract #7
Replies: 2 comments
-
|
Nggak. Kalo mau bikin gitu, isi "message" harus konsisten. Isi "data" juga keliatannya dynamic. We're trying to avoid that. Lagian kalo ada error, seharusnya hal pertama yang di cek itu HTTP status code, bukan response body. Kalo dari sisi frontend, pas fetch ya jadi aneh: |
Beta Was this translation helpful? Give feedback.
-
|
Usul saya gini aja: Pakai HTTP response code. // GET object, code: 200 OK, 404 object not found
// POST object code: 201 Created
{
id: 1,
prop1: "value1",
prop2: "value2"
}
// GET object collection, code 200 OK
// Additionally pagination metadata in headers including :
// paging-total, paging-current-page, paging-per-page, paging-page-count
[
object1,
object2,
...
]
// DELETE object, code 204 no content, 404 object not found
// PATCH object, code 200 OK, 204 if no content provided, 404 object not found
// validation fails, code: 422 Unprocessable
{
field1: ["message1", "message2"],
field2: ["message1", "message2"],
}
// server error, code 500
// body may contains stack trace information only for debuggingmungkin ada yang kurang sih, tapi saya lupa |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
Should we create an API response contract in every response, like
Beta Was this translation helpful? Give feedback.
All reactions