Best Practice Desain RESTful API Standar Industri

154 words • 1,251 chars Markdown
Raw

Best Practice Desain RESTful API Standar Industri

Merancang antarmuka REST API yang bersih, konsisten, dan mudah dipahami oleh frontend developer maupun pihak ketiga.

1. Gunakan Kata Benda Jamak (Plural Nouns) untuk Resource

Hindari penggunaan kata kerja pada URI endpoint. Gunakan HTTP Methods untuk menyatakan aksi:

  • โŒ GET /getUserDetails/12
  • โŒ POST /createUser
  • โœ… GET /users/12
  • โœ… POST /users
  • โœ… PATCH /users/12
  • โœ… DELETE /users/12

2. Struktur Response JSON yang Konsisten

Pastikan payload response memiliki format yang seragam di seluruh endpoint:

{
  "status": 200,
  "message": "User profile retrieved successfully",
  "data": {
    "id": 12,
    "username": "fajar_dev",
    "name": "Fajar Pratama"
  },
  "meta": {
    "timestamp": "2026-11-01T12:00:00Z"
  }
}

3. Tangani Error dengan Kode HTTP Status yang Tepat

  • 200 OK: Permintaan berhasil dan ada data dikembalikan.
  • 201 Created: Resource baru berhasil disimpan ke database.
  • 400 Bad Request: Validasi input gagal.
  • 401 Unauthorized: Token otentikasi tidak ada atau kedaluwarsa.
  • 403 Forbidden: User terotentikasi tapi tidak punya izin hak akses.
  • 404 Not Found: Resource tidak ditemukan.
  • 429 Too Many Requests: Rate limit terlampaui.
  • 500 Internal Server Error: Exception tak terduga di sisi server.